|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.ReportItemHandle
org.eclipse.birt.report.model.api.ListingHandle
org.eclipse.birt.report.model.api.TableHandle
public class TableHandle
Represents a table element. A table has a localized caption and can repeat its heading at the top of each page. The table is a list that is structured into a rows and columns. The columns are defined for the entire table. Rows are clustered into a set of groups.
To get the layout of a table, it is recommended to use
LayoutTableModel
.
TableItem
,
LayoutTableModel
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportItemHandle |
---|
DATABINDING_TYPE_DATA, DATABINDING_TYPE_NONE, DATABINDING_TYPE_REPORT_ITEM_REF |
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.ITableItemModel |
---|
CAPTION_KEY_PROP, CAPTION_PROP, COLUMN_SLOT, SUMMARY_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IListingElementModel |
---|
DETAIL_SLOT, FILTER_PROP, FOOTER_SLOT, GROUP_SLOT, HEADER_SLOT, ON_FINISH_METHOD, ON_ROW_METHOD, ON_START_METHOD, PAGE_BREAK_INTERVAL_PROP, REPEAT_HEADER_PROP, SORT_BY_GROUPS_PROP, SORT_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IReportItemModel |
---|
ACL_EXPRESSION_PROP, ALLOW_EXPORT_PROP, BOOKMARK_PROP, BOUND_DATA_COLUMNS_PROP, CASCADE_ACL_PROP, CUBE_PROP, DATA_BINDING_REF_PROP, DATA_SET_PROP, HEIGHT_PROP, MULTI_VIEWS_PROP, ON_CREATE_METHOD, ON_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, PARAM_BINDINGS_PROP, TOC_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP, Z_INDEX_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel |
---|
STYLE_PROP |
Fields inherited from interface org.eclipse.birt.report.model.api.elements.IReportItemMethodContext |
---|
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXT |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
TableHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for the table with the given design and element. |
Method Summary | |
---|---|
boolean |
canCopyColumn(int columnIndex)
Copies a column and cells under it with the given column number. |
boolean |
canCopyRow(RowOperationParameters parameters)
Checks whether the copy operation can be done with the given parameters. |
boolean |
canInsertAndPasteColumn(ColumnBandData data,
int columnIndex)
Checks whether the insert and paste operation can be done with the given copied column band data, the column index and the operation flag. |
boolean |
canInsertAndPasteRow(IDesignElement copiedRow,
RowOperationParameters parameters)
Checks whether the inserting and paste table row to the given destination row with the given parameters. |
boolean |
canInsertRow(RowOperationParameters parameters)
Checks whether inserting an empty table row can be done with the given parameters. |
boolean |
canPasteColumn(ColumnBandData data,
int columnIndex,
boolean inForce)
Checks whether the paste operation can be done with the given copied column band data, the column index and the operation flag. |
boolean |
canPasteRow(IDesignElement copiedRow,
RowOperationParameters parameters)
Checks whether the paste operation can be done with the given parameters. |
boolean |
canShiftColumn(int sourceColumn,
int destColumn)
Moves the column from sourceColumn to
destColumn . |
boolean |
canShiftRow(RowOperationParameters parameters)
Checks whether the shift operation can be done with the given the given parameters. |
ColumnBandData |
copyColumn(int columnIndex)
Copies a column and cells under it with the given column number. |
IDesignElement |
copyRow(RowOperationParameters parameters)
Copies table row with the given parameters. |
ColumnHandle |
findColumn(int columnNum)
Figures out the column according to the index of the column. |
java.lang.String |
getCaption()
Returns the caption text of this table. |
java.lang.String |
getCaptionKey()
Returns the resource key of the caption. |
protected CellHandle |
getCell(int row,
int column)
Gets the cell at the position where the given row and column intersect regardless of slot information. |
CellHandle |
getCell(int slotId,
int groupLevel,
int row,
int column)
Gets the cell at the position where the given row and column intersect within the given slot. |
int |
getColumnCount()
Returns the number of columns in the table. |
SlotHandle |
getColumns()
Returns the column slot. |
java.util.List |
getFilters(int colIndex)
Returns a list containing filters applied to the column at position of colIndex. |
LayoutTableModel |
getLayoutModel()
Returns the layout model of the table. |
java.lang.String |
getSummary()
Returns the value of the summary. |
void |
insertAndPasteColumn(ColumnBandData data,
int columnNumber)
Inserts and pastes a column with its cells to the given column number. |
void |
insertAndPasteRow(IDesignElement copiedRow,
RowOperationParameters parameters)
Inserts and paste table row to the given destination row with the given parameters. |
void |
insertColumn(int columnNumber,
int positionFlag)
Inserts a column to the table. |
void |
insertRow(RowOperationParameters parameters)
Inserts table row to the given destination row with the given parameters. |
void |
pasteColumn(ColumnBandData data,
int columnNumber,
boolean inForce)
Pastes a column with its cells to the given column number. |
void |
pasteRow(IDesignElement copiedRow,
RowOperationParameters parameters)
Pastes table row to destination row with the given parameters. |
void |
setCaption(java.lang.String caption)
Sets the caption text of this table. |
void |
setCaptionKey(java.lang.String captionKey)
Sets the resource key of the caption. |
void |
setSummary(java.lang.String summary)
Sets the value of summary. |
void |
shiftColumn(int sourceColumn,
int destColumn)
Moves the column from sourceColumn to
destIndex . |
void |
shiftRow(RowOperationParameters parameters)
Shifts table row to the given destination row with the given parameters. |
Methods inherited from class org.eclipse.birt.report.model.api.ListingHandle |
---|
filtersIterator, getDetail, getFooter, getGroups, getHeader, getPageBreakInterval, isSortByGroups, repeatHeader, setPageBreakInterval, setRepeatHeader, setSortByGroups, sortsIterator |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TableHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public SlotHandle getColumns()
SlotHandle
public int getColumnCount()
public java.lang.String getCaption()
public void setCaption(java.lang.String caption) throws SemanticException
caption
- the caption text
SemanticException
- if the property is locked.public java.lang.String getSummary()
public void setSummary(java.lang.String summary) throws SemanticException
summary
- the value of summary
SemanticException
public java.lang.String getCaptionKey()
public void setCaptionKey(java.lang.String captionKey) throws SemanticException
captionKey
- the resource key of the caption
SemanticException
- if the caption resource-key property is locked.public boolean canCopyColumn(int columnIndex)
columnIndex
- the column position indexing from 1.
true
if this column band can be copied. Otherwise
false
.public boolean canPasteColumn(ColumnBandData data, int columnIndex, boolean inForce)
data
- the column band data to pastecolumnIndex
- the column index from 1 to the number of columns in the tableinForce
- true
indicates to paste the column regardless
of the different layout of cells. false
indicates not.
true
indicates the paste operation can be done.
Otherwise false
.public boolean canCopyRow(RowOperationParameters parameters)
parameters
- parameters needed by insert operation.
true
if this row band can be copied. Otherwise
false
.public boolean canPasteRow(IDesignElement copiedRow, RowOperationParameters parameters)
copiedRow
- the copied table rowparameters
- parameters needed by insert operation.
true
indicates the paste operation can be done.
Otherwise false
.public boolean canInsertRow(RowOperationParameters parameters)
parameters
- parameters needed by insert operation.
true
indicates the insert operation can be done.
Otherwise false
.public boolean canInsertAndPasteRow(IDesignElement copiedRow, RowOperationParameters parameters)
copiedRow
- the copied table rowparameters
- parameters needed by insert operation.
true
indicates the insert and paste operation can
be done. Otherwise false
.public boolean canShiftRow(RowOperationParameters parameters)
parameters
- parameters needed by insert operation.
true
indicates the shift operation can be done.
Otherwise false
.public ColumnBandData copyColumn(int columnIndex) throws SemanticException
columnIndex
- the column number
ColumnBandAdapter
instance
SemanticException
- if the cell layout of the column is invalid.public void pasteColumn(ColumnBandData data, int columnNumber, boolean inForce) throws SemanticException
data
- the data of a column band to pastecolumnNumber
- the column index from 1 to the number of columns in the tableinForce
- true
if pastes the column regardless of the
warning. Otherwise false
.
SemanticException
public IDesignElement copyRow(RowOperationParameters parameters) throws SemanticException
parameters
- parameters needed by insert operation.
TableRow
instance
SemanticException
- throw if paste operation is forbidden
java.lang.IllegalArgumentException
- throw if the input parameters are not validpublic void pasteRow(IDesignElement copiedRow, RowOperationParameters parameters) throws SemanticException
copiedRow
- the copied table rowparameters
- parameters needed by insert operation.
SemanticException
- throw if paste operation is forbidden
java.lang.IllegalArgumentException
- throw if the input parameters are not validpublic void insertRow(RowOperationParameters parameters) throws SemanticException
parameters
- parameters needed by insert operation.
SemanticException
- throw if paste operation is forbidden
java.lang.IllegalArgumentException
- throw if the input parameters are not validpublic void insertAndPasteRow(IDesignElement copiedRow, RowOperationParameters parameters) throws SemanticException
copiedRow
- the copied table rowparameters
- parameters needed by insert operation.
SemanticException
- throw if paste operation is forbidden
java.lang.IllegalArgumentException
- throw if the input parameters are not validpublic void shiftRow(RowOperationParameters parameters) throws SemanticException
parameters
- parameters needed by insert operation.
SemanticException
- throw if paste operation is forbidden
java.lang.IllegalArgumentException
- throw if the input parameters are not validpublic void insertAndPasteColumn(ColumnBandData data, int columnNumber) throws SemanticException
data
- the data of a column band to pastecolumnNumber
- the column index from 0 to the number of columns in the table
SemanticException
public boolean canInsertAndPasteColumn(ColumnBandData data, int columnIndex)
canPasteColumn
since this action creates an
extra column for the table.
data
- the column band data to pastecolumnIndex
- the column index from 0 to the number of columns in the table
true
indicates the paste operation can be done.
Otherwise false
.public void shiftColumn(int sourceColumn, int destColumn) throws SemanticException
sourceColumn
to
destIndex
.
sourceColumn
- the source column ranging from 1 to the column numberdestColumn
- the target column ranging from 0 to the column number
SemanticException
- if the chosen column band is forbidden to shiftpublic boolean canShiftColumn(int sourceColumn, int destColumn)
sourceColumn
to
destColumn
.
sourceColumn
- the source column ranging from 1 to the column numberdestColumn
- the target column ranging from 0 to the column number
true
if the chosen column band is legal to shift.
Otherwise false
.public LayoutTableModel getLayoutModel()
public void insertColumn(int columnNumber, int positionFlag) throws SemanticException
The insert action cannot be finished succesfully for cases like this:
<cell colSpan="1/><cell colSpan="1/> <cell colSpan="2/>if the user want to insert a column with cells to the column 2.
columnNumber
- The 1-based column number.positionFlag
- The column insert sign. 1 insert after position. -1 insert
before position
SemanticException
- if the given position is occupied by any cell with a column
span equal or greater than 1.protected CellHandle getCell(int row, int column)
row
- the row position indexing from 1column
- the column position indexing from 1
null
public CellHandle getCell(int slotId, int groupLevel, int row, int column)
If groupLevel
is less or equal than 0, then retrieve cell
from header/detail/footer. If not, return the cell from the given group.
slotId
- the slot idgroupLevel
- the group level indexing from 1. Or -1 if to get the cell from
header/detail/footer.row
- the row position indexing from 1column
- the column position indexing from 1
null
public ColumnHandle findColumn(int columnNum)
module
- the report designcolumnSlot
- the slot contains columnscolumnNum
- the 1-based column number to search
public java.util.List getFilters(int colIndex)
colIndex
- the column index ranging from 0 to columnCount - 1
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |