Interface IReportDesign
- All Superinterfaces:
IDesignElement
Script wrapper of ReportDesignHandle
-
Method Summary
Modifier and TypeMethodDescriptionCreates the action structure.CreateIDataBinding
CreateIFilterCondition
CreateIHideRule
instanceCreateIHighLightRule
CreateISortCondition
getDataSet
(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) method to get a master page by namegetReportElement
(String name) generic method to get report item by namegetReportElementByID
(long id) Generic method to get report item by id.method to get a table item by namegetTheme()
Gets the theme for this report design.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.engine.api.script.element.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
-
Method Details
-
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
-
getReportElementByID
Generic method to get report item by id.- Parameters:
id
-- Returns:
- report element
-
getLabel
method to get a label item by name- Parameters:
name
-- Returns:
- label
-
getMasterPage
method to get a master page by name- Parameters:
name
-- Returns:
- master page
-
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
-
setDisplayNameKey
Sets the resource key of the display name.- Parameters:
displayNameKey
- the resource key of the display name- Throws:
ScriptException
- 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:
ScriptException
- if the display name property is locked or not defined on this element.
-
getDisplayName
String getDisplayName()Gets the display name.- Returns:
- the display name
-
getTheme
String getTheme()Gets the theme for this report design.- Returns:
-
setTheme
Sets the theme for this report design.- Parameters:
theme
-- Throws:
ScriptException
-
createHideRule
IHideRule createHideRule()CreateIHideRule
instance- Returns:
- IHideRule
-
createFilterCondition
IFilterCondition createFilterCondition()CreateIFilterCondition
- Returns:
- instance
-
createDataBinding
IDataBinding createDataBinding()CreateIDataBinding
- Returns:
- instance
-
createHighLightRule
IHighlightRule createHighLightRule()CreateIHighLightRule
- Returns:
- instance
-
createSortCondition
ISortCondition createSortCondition()CreateISortCondition
- 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
-