Interface ITable
- All Superinterfaces:
IDesignElement
,IListing
,IReportElement
,IReportItem
Represents the design of a Table in the scripting environment
-
Field Summary
Fields inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportItem
constants
-
Method Summary
Modifier and TypeMethodDescriptionReturns the caption text of this table.Returns the resource key of the caption.getColumn
(int index) Gets column.int
Returns the number of columns in the table.Gets the summary of this table.boolean
Tests whether to repeat the headings at the top of each page.void
setCaption
(String caption) Sets the caption text of this table.void
setCaptionKey
(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
setSummary
(String summary) Sets the summary of this table.Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IListing
addFilterCondition, addSortCondition, getFilterConditions, getSortConditions, removeFilterCondition, removeFilterConditions, removeSortCondition, removeSortConditions
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportElement
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName
Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportItem
addDataBinding, addHideRule, addHighlightRule, getBookmark, getDataBinding, getDataBindings, getHeight, getHideRules, getHighlightRules, getTocExpression, getWidth, getX, getY, removeDataBinding, removeDataBindings, removeHideRule, removeHideRules, removeHighlightRule, removeHighlightRules, setBookmark, setCurrentView, setHeight, setHeight, setTocExpression, setWidth, setWidth, setX, setX, setY, setY
-
Method Details
-
getColumnCount
int getColumnCount()Returns the number of columns in the table. The number is defined as 1) the sum of columns described in the "column" slot, or 2) the widest row defined in the detail, header or footer slots if column slot is empty.- Returns:
- the number of columns in the table
-
repeatHeader
boolean repeatHeader()Tests whether to repeat the headings at the top of each page.- Returns:
true
if repeat the headings, otherwisefalse
.
-
setRepeatHeader
Sets whether to repeat the headings at the top of each page.- Parameters:
value
-true
if repeat the headings, otherwisefalse
.- Throws:
ScriptException
- if the property is locked.
-
getSummary
String getSummary()Gets the summary of this table.- Returns:
- the summary.
-
setSummary
Sets the summary of this table.- Parameters:
summary
- the summary- Throws:
org.eclipse.birt.report.model.api.activity.SemanticException
- if this property is locked.ScriptException
-
getCaption
String getCaption()Returns the caption text of this table.- Returns:
- the caption text
-
setCaption
Sets the caption text of this table.- Parameters:
caption
- the caption text- Throws:
ScriptException
- if the property is locked.
-
getCaptionKey
String getCaptionKey()Returns the resource key of the caption.- Returns:
- the resource key of the caption
-
setCaptionKey
Sets the resource key of the caption.- Parameters:
captionKey
- the resource key of the caption- Throws:
ScriptException
- if the caption resource-key property is locked.
-
getColumn
Gets column.- Parameters:
index
-- Returns:
- column wrapper
-