org.eclipse.birt.report.engine.api.script.element
Interface IReportDesign

All Superinterfaces:

IDesignElement

public interface IReportDesign

extends IDesignElement

Script wrapper of ReportDesignHandle

Method Summary

IDataSet	getDataSet(java.lang.String name) method to get data set design by name
IDataSource	getDataSource(java.lang.String name) method to get data source design by name
java.lang.String	getDisplayName() Gets the display name.
java.lang.String	getDisplayNameKey() Gets the resource key of the display name.
IDynamicText	getDynamicText(java.lang.String name) method to get a dynamic text data item by name.
IGrid	getGrid(java.lang.String name) method to get a grid item by name
IImage	getImage(java.lang.String name) mathod to get a Image item by name
ILabel	getLabel(java.lang.String name) method to get a label item by name
IList	getList(java.lang.String name) method to get a list item by name
IMasterPage	getMasterPage(java.lang.String name) method to get a master page by name
IReportElement	getReportElement(java.lang.String name) generic method to get report item by name
ITable	getTable(java.lang.String name) method to get a table item by name
void	setDisplayName(java.lang.String displayName) Sets the display name.
void	setDisplayNameKey(java.lang.String displayNameKey) Sets the resource key of the display name.

Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement

getNamedExpression, getParent, getQualifiedName, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty

Method Detail

getDataSet

public IDataSet getDataSet(java.lang.String name)

method to get data set design by name

Parameters:

name -

Returns:

data set

getDataSource

public IDataSource getDataSource(java.lang.String name)

method to get data source design by name

Parameters:

name -

Returns:

data source

getReportElement

public IReportElement getReportElement(java.lang.String name)

generic method to get report item by name

Parameters:

name -

Returns:

report element

getLabel

public ILabel getLabel(java.lang.String name)

method to get a label item by name

Parameters:

name -

Returns:

label

getMasterPage

public IMasterPage getMasterPage(java.lang.String name)

method to get a master page by name

Parameters:

name -

Returns:

master page

getGrid

public IGrid getGrid(java.lang.String name)

method to get a grid item by name

Parameters:

name -

Returns:

grid

getImage

public IImage getImage(java.lang.String name)

mathod to get a Image item by name

Parameters:

name -

Returns:

iamge

getList

public IList getList(java.lang.String name)

method to get a list item by name

Parameters:

name -

Returns:

list

getTable

public ITable getTable(java.lang.String name)

method to get a table item by name

Parameters:

name -

Returns:

table

getDynamicText

public IDynamicText getDynamicText(java.lang.String name)

method to get a dynamic text data item by name.

Parameters:

name -

Returns:

text data

setDisplayNameKey

public void setDisplayNameKey(java.lang.String displayNameKey)
                       throws ScriptException

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

public java.lang.String getDisplayNameKey()

Gets the resource key of the display name.

Returns:

the resource key of the display name

setDisplayName

public void setDisplayName(java.lang.String displayName)
                    throws ScriptException

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

public java.lang.String getDisplayName()

Gets the display name.

Returns:

the display name