Interface IReportDesign
- All Superinterfaces:
IDesignElement
Script wrapper of ReportDesignHandle
-
Method Summary
Modifier and TypeMethodDescriptionCreates the action structure.CreateIDataBinding
CreateIFilterCondition
Create IHideRule instanceCreate IHighLightRuleCreate ISortConditiongetDataItem
(String name) method to get a data item by namegetDataSet
(String name) method to get data set design by namegetDataSource
(String name) method to get data source design by nameGets the display name.Gets the resource key of the display name.getDynamicText
(String name) method to get a dynamic text data item by name.method to get a grid item by namemathod to get a Image item by namemethod to get a label item by namemethod to get a list item by namegetMasterPage
(String name) Gets master page script instance.getReportElement
(String name) generic method to get report item by namegetReportElementByID
(long id) generic method to get report item by idmethod to get a table item by namegetTextItem
(String name) method to get a text item by namegetTheme()
Gets the theme for this report design.void
save()
Saves the module to an existing file name.void
Saves the design to the file name provided.void
setDisplayName
(String displayName) Sets the display name.void
setDisplayNameKey
(String displayNameKey) Sets the resource key of the display name.void
Sets the theme for this report design.Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
-
Method Details
-
getMasterPage
Gets master page script instance.- Parameters:
name
-- Returns:
- master page script instance
-
getDataSet
method to get data set design by name- Parameters:
name
-- Returns:
- data set
-
getDataSource
method to get data source design by name- Parameters:
name
-- Returns:
- data source
-
getReportElement
generic method to get report item by name- Parameters:
name
-- Returns:
- report element
-
getLabel
method to get a label item by name- Parameters:
name
-- Returns:
- label
-
getGrid
method to get a grid item by name- Parameters:
name
-- Returns:
- grid
-
getImage
mathod to get a Image item by name- Parameters:
name
-- Returns:
- iamge
-
getList
method to get a list item by name- Parameters:
name
-- Returns:
- list
-
getTable
method to get a table item by name- Parameters:
name
-- Returns:
- table
-
getDynamicText
method to get a dynamic text data item by name.- Parameters:
name
-- Returns:
- text data
-
getDataItem
method to get a data item by name- Parameters:
name
-- Returns:
- data item
-
getTextItem
method to get a text item by name- Parameters:
name
-- Returns:
- text item
-
setDisplayNameKey
Sets the resource key of the display name.- Parameters:
displayNameKey
- the resource key of the display name- Throws:
SemanticException
- if the display name resource-key property is locked or not defined on this element.
-
getDisplayNameKey
String getDisplayNameKey()Gets the resource key of the display name.- Returns:
- the resource key of the display name
-
setDisplayName
Sets the display name.- Parameters:
displayName
- the display name- Throws:
SemanticException
- if the display name property is locked or not defined on this element.
-
getDisplayName
String getDisplayName()Gets the display name.- Returns:
- the display name
-
save
Saves the module to an existing file name. Call this only when the file name has been set.- Throws:
IOException
- if the file cannot be saved on the storage. Or the file name is not valid.- See Also:
-
saveAs
Saves the design to the file name provided. The file name is saved in the design, and subsequent calls tosave( )
will save to this new name.- Parameters:
newName
- the new file name- Throws:
IOException
- if the file cannot be saved. Or the file name is not valid.- See Also:
-
getTheme
String getTheme()Gets the theme for this report design.- Returns:
- the theme for this report design.
-
setTheme
Sets the theme for this report design.- Parameters:
theme
-- Throws:
SemanticException
-
getReportElementByID
generic method to get report item by id- Parameters:
name
-- Returns:
- report element
-
createFilterCondition
IFilterCondition createFilterCondition()CreateIFilterCondition
- Returns:
- instance
-
createHideRule
IHideRule createHideRule()Create IHideRule instance- Returns:
- IHideRule
-
createHighLightRule
IHighlightRule createHighLightRule()Create IHighLightRule- Returns:
- instance
-
createSortCondition
ISortCondition createSortCondition()Create ISortCondition- Returns:
- instance
-
createAction
IAction createAction()Creates the action structure.- Parameters:
action
- the structure handlehandle
- the element handle that holds the action structure- Returns:
- the action
-
createDataBinding
IDataBinding createDataBinding()CreateIDataBinding
- Returns:
- instance
-