Interface IReportDesign
-
- All Superinterfaces:
IDesignElement
public interface IReportDesign extends IDesignElement
Script wrapper of ReportDesignHandle
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IActioncreateAction()Creates the action structure.IDataBindingcreateDataBinding()CreateIDataBindingIFilterConditioncreateFilterCondition()CreateIFilterConditionIHideRulecreateHideRule()CreateIHideRuleinstanceIHighlightRulecreateHighLightRule()CreateIHighLightRuleISortConditioncreateSortCondition()CreateISortConditionIDataSetgetDataSet(java.lang.String name)method to get data set design by nameIDataSourcegetDataSource(java.lang.String name)method to get data source design by namejava.lang.StringgetDisplayName()Gets the display name.java.lang.StringgetDisplayNameKey()Gets the resource key of the display name.IDynamicTextgetDynamicText(java.lang.String name)method to get a dynamic text data item by name.IGridgetGrid(java.lang.String name)method to get a grid item by nameIImagegetImage(java.lang.String name)mathod to get a Image item by nameILabelgetLabel(java.lang.String name)method to get a label item by nameIListgetList(java.lang.String name)method to get a list item by nameIMasterPagegetMasterPage(java.lang.String name)method to get a master page by nameIReportElementgetReportElement(java.lang.String name)generic method to get report item by nameIReportElementgetReportElementByID(long id)Generic method to get report item by id.ITablegetTable(java.lang.String name)method to get a table item by namejava.lang.StringgetTheme()Gets the theme for this report design.voidsetDisplayName(java.lang.String displayName)Sets the display name.voidsetDisplayNameKey(java.lang.String displayNameKey)Sets the resource key of the display name.voidsetTheme(java.lang.String theme)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 Detail
-
getDataSet
IDataSet getDataSet(java.lang.String name)
method to get data set design by name- Parameters:
name-- Returns:
- data set
-
getDataSource
IDataSource getDataSource(java.lang.String name)
method to get data source design by name- Parameters:
name-- Returns:
- data source
-
getReportElement
IReportElement getReportElement(java.lang.String name)
generic method to get report item by name- Parameters:
name-- Returns:
- report element
-
getReportElementByID
IReportElement getReportElementByID(long id)
Generic method to get report item by id.- Parameters:
id-- Returns:
- report element
-
getLabel
ILabel getLabel(java.lang.String name)
method to get a label item by name- Parameters:
name-- Returns:
- label
-
getMasterPage
IMasterPage getMasterPage(java.lang.String name)
method to get a master page by name- Parameters:
name-- Returns:
- master page
-
getGrid
IGrid getGrid(java.lang.String name)
method to get a grid item by name- Parameters:
name-- Returns:
- grid
-
getImage
IImage getImage(java.lang.String name)
mathod to get a Image item by name- Parameters:
name-- Returns:
- iamge
-
getList
IList getList(java.lang.String name)
method to get a list item by name- Parameters:
name-- Returns:
- list
-
getTable
ITable getTable(java.lang.String name)
method to get a table item by name- Parameters:
name-- Returns:
- table
-
getDynamicText
IDynamicText getDynamicText(java.lang.String name)
method to get a dynamic text data item by name.- Parameters:
name-- Returns:
- text data
-
setDisplayNameKey
void setDisplayNameKey(java.lang.String displayNameKey) throws ScriptExceptionSets 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
java.lang.String getDisplayNameKey()
Gets the resource key of the display name.- Returns:
- the resource key of the display name
-
setDisplayName
void setDisplayName(java.lang.String displayName) throws ScriptExceptionSets the display name.- Parameters:
displayName- the display name- Throws:
ScriptException- if the display name property is locked or not defined on this element.
-
getDisplayName
java.lang.String getDisplayName()
Gets the display name.- Returns:
- the display name
-
getTheme
java.lang.String getTheme()
Gets the theme for this report design.- Returns:
-
setTheme
void setTheme(java.lang.String theme) throws ScriptExceptionSets the theme for this report design.- Parameters:
theme-- Throws:
ScriptException
-
createHideRule
IHideRule createHideRule()
CreateIHideRuleinstance- 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
-
-