public interface ReportCollection
ReportInterface
.
Provides basic operations for working with the contained ReportLine
-s.
The access to the collection lines is list-like (based on index). Implementors of
this interface are expected to extend ApplicationDesigner collections
(GRIDCollection, TREECollection etc.) so that they are usable inside adapters
and layouts.ReportInterface
,
CollectionContext
Modifier and Type | Method and Description |
---|---|
void |
add(ReportLine line)
Adds the given line.
|
void |
clear()
Clears the contents of this collection by removing all lines.
|
CollectionContext |
getCollectionContext()
Retrieves the
CollectionContext for this collection. |
ReportLine |
getLine(int index)
Retrieves the line on the given index.
|
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 |
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 |
setReport(com.centrasite.control.ReportInterface report)
Sets the given
ReportInterface to be used by this collection. |
ReportLine newReportLine(com.centrasite.control.Row row)
row
- Row instance providing access to property values.void add(ReportLine line)
line
- void remove(ReportLine line)
line
- void replace(int oldLineIndex, ReportLine newLine)
oldLineIndex
- Index of the line to be replaced.newLine
- Line to be added.int getTotalSize()
ReportLine getLine(int index)
index
- void clear()
java.util.List<ReportLine> getReportLines()
com.centrasite.control.ReportInterface getReport()
ReportInterface
instance used by this collection.void setReport(com.centrasite.control.ReportInterface report)
ReportInterface
to be used by this collection.report
- void refreshValue(com.centrasite.control.ReportInterface report)
ReportInterface
.
This includes clearing all lines, executing the report and populating the lines again.report
- void initWithNullItems(int size, ReportCollectionListener reportCollectionListener)
ReportCollectionListener
.
The actual null items are implementation specific.size
- reportCollectionListener
- void setColumnsChanged()
CollectionContext getCollectionContext()
CollectionContext
for this collection.void setCollectionContext(CollectionContext context)
CollectionContext
for this collection.context
- int referencesItem(com.centrasite.control.Item item, int change)
item
- item to checkchange
- one of the constants ITEM_CREATED, ITEM_DELETED, ...