com.centrasite.control.adapters.collection.tree
Class TreeCollection

java.lang.Object
  extended by com.softwareag.cis.server.util.TREECollection
      extended by com.centrasite.control.adapters.collection.tree.TreeCollection
All Implemented Interfaces:
ReportCollection, com.softwareag.cis.server.IDynamicAccess, com.softwareag.cis.server.util.ISSSARRAYInfo
Direct Known Subclasses:
BrowseTreeCollection

public class TreeCollection
extends com.softwareag.cis.server.util.TREECollection
implements com.softwareag.cis.server.IDynamicAccess, ReportCollection

Report collection extending the Application Designer's TREECollection.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.softwareag.cis.server.util.TREECollection
com.softwareag.cis.server.util.TREECollection.ItemIndex, com.softwareag.cis.server.util.TREECollection.TREENODEInfo
 
Field Summary
 
Fields inherited from class com.softwareag.cis.server.util.TREECollection
KEY_CTRL, KEY_NONE, KEY_SHIFT, LI_NOLINE, LI_VHEDGE, LI_VHLINE, LI_VLINE, ST_CLOSED, ST_ENDNODE, ST_OPENED
 
Constructor Summary
TreeCollection(FlexLineColumnsCollectionContext treeCollectionContext)
           
 
Method Summary
 void add(ReportLine line)
          Adds the given line.
 com.centrasite.control.ActionContext getActionContext()
           
 CollectionContext getCollectionContext()
          Retrieves the CollectionContext for this collection.
 com.softwareag.cis.server.util.FLEXLINEInfo getColumns()
           
 java.lang.String[] getDynamicAccessProperties()
           
 ReportLine getLine(int index)
          Retrieves the line on the given index.
 com.softwareag.cis.server.util.FLEXLINEInfo getLineContent()
           
 com.softwareag.cis.server.util.TREECollection getLines()
           
 com.centrasite.control.ReportInterface getReport()
          Retrieves the ReportInterface instance used by this collection.
 java.util.List<ReportLine> getReportLines()
          Retrieves all collection lines.
 int getTotalSize()
          Determines the size of the collection.
 void initToolbar()
           
 void initWithNullItems(int size, ReportCollectionListener reportCollectionListener)
          Initializes the collection with null values and ReportCollectionListener.
 TreeItemLine newReportLine(com.centrasite.control.Row row)
          Creates new collection line using the given row.
 void reactOnDblClick()
          Double click on line in table has been performed: execute default command
 int referencesItem(com.centrasite.control.Item item, int change)
          Is the specified item referenced by this collection.
 void refreshValue(com.centrasite.control.ReportInterface report)
          Reinitialize the collection with the given ReportInterface.
 void remove(com.centrasite.control.Item item)
           
 void remove(ReportLine line)
          Removes the given line.
 void replace(int oldLineIndex, ReportLine newLine)
          Replaces the line on the given index with the given line.
 void setActionContext(ReportCollectionActionContext actionContext)
           
 void setCollectionContext(CollectionContext context)
          Sets the CollectionContext for this collection.
 void setColumnsChanged()
          Notifies that columns have changed so that this collection reinitializes its columns.
 void setReport(com.centrasite.control.ReportInterface report)
          Sets the given ReportInterface to be used by this collection.
 void setRows(com.centrasite.control.RowIterator rowIt)
           
 void setTreeListener(ReportCollectionListener listener)
           
 void sortItems(java.lang.String propName, boolean ascending)
           
 
Methods inherited from class com.softwareag.cis.server.util.TREECollection
addGridColHeaderChangeListener, addSideNode, addSideNodes, addSideTree, addSubNode, addSubNodes, addSubTree, addTopNode, addTopNode, addTopNodes, addTopTree, addToSelection, checkIfItemIsSelected, clear, clearSelection, clearSelectionOfNode, closeAllNodes, displayItem, findChildNodes, findDynamicAccessProperties, findListOfTreeNodes, findParentNode, findRowCount, findSelectedItem, findSelectedItems, findTopNodes, findTreeNodeByText, findTreeNodeByText, findTreeNodeByTextId, findTreeNodeByTextId, getChangeIndex, getClassForProperty, getItems, getOnPageDownVis, getOnPageUpVis, getParam1, getPropertyValue, getRowCount, getSelectedIndex, getSelectedItemIndices, getSize, getSortLocale, getTopIndex, getTreeNodesSelectedIndex, invokeMethod, itemChanged, moveNode, moveNodeAsideTarget, moveNodeBelowTarget, onFirstPage, onLastPage, onPageDown, onPageUp, openAllNodes, reactOnGridColHeaderContextMenuRequest, reactOnGridColHeaderDoubleClick, reactOnGridColHeaderMove, reactOnGridColHeaderResize, registerGridColHeaderChangeListener, removeNode, removeSubTree, replaceNode, restoreGridColHeaderWidths, selectAndDisplayItem, selectAndDisplayItem, setCtrlSelectedIndex, setCtrlSelectIndex, setPropertyValue, setRowCount, setSelectedIndex, setSelectedItem, setShiftSelectedIndex, setShiftSelectIndex, setSortLocale, setSSSTREECollectionListener, setTopIndex, toggleNode, toggleNodeWithAutoScroll
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.softwareag.cis.server.IDynamicAccess
findDynamicAccessProperties, getClassForProperty, getPropertyValue, invokeMethod, setPropertyValue
 
Methods inherited from interface com.centrasite.control.adapters.collection.ReportCollection
clear
 

Constructor Detail

TreeCollection

public TreeCollection(FlexLineColumnsCollectionContext treeCollectionContext)
Method Detail

setReport

public void setReport(com.centrasite.control.ReportInterface report)
Description copied from interface: ReportCollection
Sets the given ReportInterface to be used by this collection.

Specified by:
setReport in interface ReportCollection

getReport

public com.centrasite.control.ReportInterface getReport()
Description copied from interface: ReportCollection
Retrieves the ReportInterface instance used by this collection.

Specified by:
getReport in interface ReportCollection
Returns:
ReportInterface

setTreeListener

public void setTreeListener(ReportCollectionListener listener)

refreshValue

public void refreshValue(com.centrasite.control.ReportInterface report)
Description copied from interface: ReportCollection
Reinitialize the collection with the given ReportInterface. This includes clearing all lines, executing the report and populating the lines again.

Specified by:
refreshValue in interface ReportCollection

setRows

public void setRows(com.centrasite.control.RowIterator rowIt)

setActionContext

public void setActionContext(ReportCollectionActionContext actionContext)

getColumns

public com.softwareag.cis.server.util.FLEXLINEInfo getColumns()

getLineContent

public com.softwareag.cis.server.util.FLEXLINEInfo getLineContent()

reactOnDblClick

public void reactOnDblClick()
Double click on line in table has been performed: execute default command


getActionContext

public com.centrasite.control.ActionContext getActionContext()

referencesItem

public int referencesItem(com.centrasite.control.Item item,
                          int change)
Description copied from interface: ReportCollection
Is the specified item referenced by this collection.

Specified by:
referencesItem in interface ReportCollection
Parameters:
item - item to check
change - one of the constants ITEM_CREATED, ITEM_DELETED, ...
Returns:
NOT_REFERENCED, SINGLE_VALUE_PAGE_REFERENCE or MULTI_VALUE_PAGE_REFERENCE

getLines

public com.softwareag.cis.server.util.TREECollection getLines()

initToolbar

public void initToolbar()

getDynamicAccessProperties

public java.lang.String[] getDynamicAccessProperties()

setColumnsChanged

public void setColumnsChanged()
Description copied from interface: ReportCollection
Notifies that columns have changed so that this collection reinitializes its columns.

Specified by:
setColumnsChanged in interface ReportCollection

add

public void add(ReportLine line)
Description copied from interface: ReportCollection
Adds the given line.

Specified by:
add in interface ReportCollection

getCollectionContext

public CollectionContext getCollectionContext()
Description copied from interface: ReportCollection
Retrieves the CollectionContext for this collection.

Specified by:
getCollectionContext in interface ReportCollection
Returns:
CollectionContext

getLine

public ReportLine getLine(int index)
Description copied from interface: ReportCollection
Retrieves the line on the given index.

Specified by:
getLine in interface ReportCollection
Returns:
ReportLine

getTotalSize

public int getTotalSize()
Description copied from interface: ReportCollection
Determines the size of the collection.

Specified by:
getTotalSize in interface ReportCollection
Overrides:
getTotalSize in class com.softwareag.cis.server.util.TREECollection
Returns:
The size.

getReportLines

public java.util.List<ReportLine> getReportLines()
Description copied from interface: ReportCollection
Retrieves all collection lines.

Specified by:
getReportLines in interface ReportCollection
Returns:
List

initWithNullItems

public void initWithNullItems(int size,
                              ReportCollectionListener reportCollectionListener)
Description copied from interface: ReportCollection
Initializes the collection with null values and ReportCollectionListener. The actual null items are implementation specific.

Specified by:
initWithNullItems in interface ReportCollection

newReportLine

public TreeItemLine newReportLine(com.centrasite.control.Row row)
Description copied from interface: ReportCollection
Creates new collection line using the given row.

Specified by:
newReportLine in interface ReportCollection
Parameters:
row - Row instance providing access to property values.
Returns:
ReportLine

remove

public void remove(ReportLine line)
Description copied from interface: ReportCollection
Removes the given line.

Specified by:
remove in interface ReportCollection

remove

public void remove(com.centrasite.control.Item item)

replace

public void replace(int oldLineIndex,
                    ReportLine newLine)
Description copied from interface: ReportCollection
Replaces the line on the given index with the given line.

Specified by:
replace in interface ReportCollection
Parameters:
oldLineIndex - Index of the line to be replaced.
newLine - Line to be added.

setCollectionContext

public void setCollectionContext(CollectionContext context)
Description copied from interface: ReportCollection
Sets the CollectionContext for this collection.

Specified by:
setCollectionContext in interface ReportCollection

sortItems

public void sortItems(java.lang.String propName,
                      boolean ascending)
Overrides:
sortItems in class com.softwareag.cis.server.util.TREECollection