Interface IGrid
- All Superinterfaces:
IDesignElement
,IReportElement
,IReportItem
Represents a the design of a Grid in the scripting environment
-
Field Summary
Fields inherited from interface org.eclipse.birt.report.model.api.simpleapi.IReportItem
constants
-
Method Summary
Modifier and TypeMethodDescriptionReturns the caption text of this grid.Returns the resource key of the caption.int
Returns the number of columns in the Grid.Gets the summary of this grid.void
setCaption
(String caption) Sets the caption text of this grid.void
setCaptionKey
(String captionKey) Sets the resource key of the caption.void
setSummary
(String summary) Sets the summary of this grid.Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IReportElement
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.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 Grid. The number is defined as the sum of columns described in the "column" slot.- Returns:
- the number of columns in the grid.
-
getSummary
String getSummary()Gets the summary of this grid.- Returns:
- the summary.
-
setSummary
Sets the summary of this grid.- Parameters:
summary
- the summary- Throws:
SemanticException
- if this property is locked.
-
getCaption
String getCaption()Returns the caption text of this grid.- Returns:
- the caption text
-
setCaption
Sets the caption text of this grid.- Parameters:
caption
- the caption text- Throws:
SemanticException
- 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:
SemanticException
- if the caption resource-key property is locked.
-