|
|||||||||||
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
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.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, REPEAT_HEADER_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, SORT_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IReportItemModel |
BOOKMARK_PROP, DATA_SET_PROP, HEIGHT_PROP, ON_CREATE_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, PARAM_BINDINGS_PROP, TOC_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel |
STYLE_PROP |
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 |
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 |
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 |
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 |
canShiftColumn(int sourceColumn,
int destColumn)
Moves the column from sourceColumn to
destColumn . |
ColumnBandData |
copyColumn(int columnIndex)
Copies a column and cells under it with the given column number. |
java.lang.String |
getCaption()
Returns the caption text of this table. |
java.lang.String |
getCaptionKey()
Returns the resource key of the caption. |
int |
getColumnCount()
Returns the number of columns in the table. |
SlotHandle |
getColumns()
Returns the column slot. |
LayoutTableModel |
getLayoutModel()
Returns the layout model of the table. |
void |
insertAndPasteColumn(ColumnBandData data,
int columnNumber)
Inserts and pastes a column with its cells to the given column number. |
void |
pasteColumn(ColumnBandData data,
int columnNumber,
boolean inForce)
Pastes a column with its cells to the given column number. |
boolean |
repeatHeader()
Tests whether to repeat the headings at the top of each page. |
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 |
setRepeatHeader(boolean value)
Sets whether to repeat the headings at the top of each page. |
void |
shiftColumn(int sourceColumn,
int destColumn)
Moves the column from sourceColumn to
destIndex . |
Methods inherited from class org.eclipse.birt.report.model.api.ListingHandle |
filtersIterator, getDetail, getFooter, getGroups, getHeader, getPageBreakInterval, setPageBreakInterval, sortsIterator |
Methods inherited from class org.eclipse.birt.report.model.api.ReportItemHandle |
getBookmark, getDataSet, getHeight, getOnCreate, getOnPrepare, getOnRender, getTocExpression, getWidth, getX, getY, paramBindingsIterator, setBookmark, setDataSet, setHeight, setHeight, setOnCreate, setOnPrepare, setOnRender, setTocExpression, setWidth, setWidth, setX, setX, setY, setY, visibilityRulesIterator |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, 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 boolean repeatHeader()
true
if repeat the headings, otherwise
false
.public void setRepeatHeader(boolean value) throws SemanticException
value
- true
if repeat the headings, otherwise
false
.
SemanticException
- if the property is locked.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 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 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 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()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |