com.centrasite.control.adapters.collection.grid
Class GridCollection

java.lang.Object
  extended by com.softwareag.cis.server.util.SSSARRAYInfo
      extended by com.softwareag.cis.server.util.GRIDCollection
          extended by com.centrasite.control.adapters.collection.grid.GridCollection
All Implemented Interfaces:
ReportCollection, com.softwareag.cis.server.IDynamicAccess, com.softwareag.cis.server.util.ISSSARRAYInfo, java.lang.Iterable, java.util.Collection, java.util.List

public class GridCollection
extends com.softwareag.cis.server.util.GRIDCollection
implements ReportCollection

Report collection extending the Application Designer's GRIDCollection.


Nested Class Summary
 class GridCollection.SortInfo
           
 
Nested classes/interfaces inherited from class com.softwareag.cis.server.util.GRIDCollection
com.softwareag.cis.server.util.GRIDCollection.MySORTInfo
 
Nested classes/interfaces inherited from class com.softwareag.cis.server.util.SSSARRAYInfo
com.softwareag.cis.server.util.SSSARRAYInfo.GRIDSORTInfo
 
Constructor Summary
GridCollection(FlexLineColumnsCollectionContext gridCollectionContext)
           
 
Method Summary
 void add(ReportLine line)
          Adds the given line.
 boolean equals(java.lang.Object other)
           
 CollectionContext getCollectionContext()
          Retrieves the CollectionContext for this collection.
 com.softwareag.cis.server.util.FLEXLINEInfo getColumns()
           
 java.lang.String[] getDynamicAccessProperties()
           
 java.lang.Object[] getItems()
           
 ReportLine getLine(int index)
          Retrieves the line on the given index.
 com.softwareag.cis.server.util.FLEXLINEInfo getLineContent()
           
 java.lang.String getOnloadBehaviour()
           
 java.lang.String getParam1()
          Deprecated. for internal use only
 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.
 int hashCode()
           
 void initWithNullItems(int size, ReportCollectionListener reportCollectionListener)
          Initializes the collection with null values and ReportCollectionListener.
 ReportLine newReportLine(com.centrasite.control.Row row)
          Creates new collection line using the given row.
 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(ReportLine line)
          Removes the given line.
 void replace(int oldLineIndex, ReportLine newLine)
          Replaces the line on the given index with the given line.
 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 setOnloadBehaviour(java.lang.String value)
           
 void setReport(com.centrasite.control.ReportInterface report)
          Sets the given ReportInterface to be used by this collection.
 
Methods inherited from class com.softwareag.cis.server.util.GRIDCollection
getLastSelectedIndex, getMultiSelectProp, getSelectableProp, getSelectProp, getSingleSelectProp, itemChanged, onImportClipboardContent, selectItem, setClipboardContent, setCtrlSelectIndex, setLastSelectedIndex, setMultiSelectProp, setPlusOneItem, setSelectableProp, setSelectIndex, setSelectionX1, setSelectionX2, setSelectionY1, setSelectionY2, setSelectProp, setShiftSelectIndex, setSingleSelectProp, setValuepropsCSV
 
Methods inherited from class com.softwareag.cis.server.util.SSSARRAYInfo
add, add, addAll, addAll, addGridColHeaderChangeListener, addToBottom, clear, contains, containsAll, displayItem, findDynamicAccessProperties, get, getAllItems, getArrayInfoListener, getClassForProperty, getItemsVector, getOnPageDownVis, getOnPageUpVis, getPropertyValue, getRowCount, getSize, getSortInfo, getTopIndex, indexOf, initWithNullItems, invokeMethod, isEmpty, iterator, lastIndexOf, listIterator, listIterator, onFirstPage, onLastPage, onPageDown, onPageUp, prepareColumnSort, reactOnGridColHeaderContextMenuRequest, reactOnGridColHeaderDoubleClick, reactOnGridColHeaderMove, reactOnGridColHeaderResize, registerGridColHeaderChangeListener, remove, remove, removeAll, restoreGridColHeaderWidths, retainAll, set, setPropertyValue, setRowCount, setTopIndex, size, sort, subList, toArray, toArray
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.centrasite.control.adapters.collection.ReportCollection
clear
 
Methods inherited from interface com.softwareag.cis.server.IDynamicAccess
findDynamicAccessProperties, getClassForProperty, getPropertyValue, invokeMethod, setPropertyValue
 

Constructor Detail

GridCollection

public GridCollection(FlexLineColumnsCollectionContext gridCollectionContext)
Method Detail

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

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

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 ReportLine 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

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

remove

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

Specified by:
remove in interface ReportCollection

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

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

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

getDynamicAccessProperties

public java.lang.String[] getDynamicAccessProperties()

getColumns

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

getLineContent

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

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

getOnloadBehaviour

public java.lang.String getOnloadBehaviour()
Overrides:
getOnloadBehaviour in class com.softwareag.cis.server.util.SSSARRAYInfo

setOnloadBehaviour

public void setOnloadBehaviour(java.lang.String value)
Overrides:
setOnloadBehaviour in class com.softwareag.cis.server.util.SSSARRAYInfo

getParam1

public java.lang.String getParam1()
Deprecated. for internal use only

Overrides:
getParam1 in class com.softwareag.cis.server.util.SSSARRAYInfo

getItems

public java.lang.Object[] getItems()
Specified by:
getItems in interface com.softwareag.cis.server.util.ISSSARRAYInfo
Overrides:
getItems in class com.softwareag.cis.server.util.SSSARRAYInfo

equals

public boolean equals(java.lang.Object other)
Specified by:
equals in interface java.util.Collection
Specified by:
equals in interface java.util.List
Overrides:
equals in class com.softwareag.cis.server.util.SSSARRAYInfo

hashCode

public int hashCode()
Specified by:
hashCode in interface java.util.Collection
Specified by:
hashCode in interface java.util.List
Overrides:
hashCode in class com.softwareag.cis.server.util.SSSARRAYInfo

getTotalSize

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

Specified by:
getTotalSize in interface ReportCollection
Returns:
The size.