Interface IReportDesign

All Superinterfaces:

IDesignElement

public interface IReportDesign
extends IDesignElement

Script wrapper of ReportDesignHandle

Method Summary

Modifier and Type	Method	Description
IAction	createAction()	Creates the action structure.
IDataBinding	createDataBinding()	Create IDataBinding
IFilterCondition	createFilterCondition()	Create IFilterCondition
IHideRule	createHideRule()	Create IHideRule instance
IHighlightRule	createHighLightRule()	Create IHighLightRule
ISortCondition	createSortCondition()	Create ISortCondition
IDataSet	getDataSet(String name)	method to get data set design by name
IDataSource	getDataSource(String name)	method to get data source design by name
String	getDisplayName()	Gets the display name.
String	getDisplayNameKey()	Gets the resource key of the display name.
IDynamicText	getDynamicText(String name)	method to get a dynamic text data item by name.
IGrid	getGrid(String name)	method to get a grid item by name
IImage	getImage(String name)	mathod to get a Image item by name
ILabel	getLabel(String name)	method to get a label item by name
IList	getList(String name)	method to get a list item by name
IMasterPage	getMasterPage(String name)	method to get a master page by name
IReportElement	getReportElement(String name)	generic method to get report item by name
IReportElement	getReportElementByID(long id)	Generic method to get report item by id.
ITable	getTable(String name)	method to get a table item by name
String	getTheme()	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	setTheme(String theme)	Sets the theme for this report design.

Methods inherited from interface IDesignElement

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

Method Details

getDataSet

IDataSet getDataSet(String name)

method to get data set design by name

Parameters:

name -

Returns:

data set

getDataSource

IDataSource getDataSource(String name)

method to get data source design by name

Parameters:

name -

Returns:

data source

getReportElement

IReportElement getReportElement(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(String name)

method to get a label item by name

Parameters:

name -

Returns:

label

getMasterPage

IMasterPage getMasterPage(String name)

method to get a master page by name

Parameters:

name -

Returns:

master page

getGrid

IGrid getGrid(String name)

method to get a grid item by name

Parameters:

name -

Returns:

grid

getImage

IImage getImage(String name)

mathod to get a Image item by name

Parameters:

name -

Returns:

iamge

getList

IList getList(String name)

method to get a list item by name

Parameters:

name -

Returns:

list

getTable

ITable getTable(String name)

method to get a table item by name

Parameters:

name -

Returns:

table

getDynamicText

IDynamicText getDynamicText(String name)

method to get a dynamic text data item by name.

Parameters:

name -

Returns:

text data

setDisplayNameKey

void setDisplayNameKey(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

String getDisplayNameKey()

Gets the resource key of the display name.

Returns:

the resource key of the display name

setDisplayName

void setDisplayName(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

String getDisplayName()

Gets the display name.

Returns:

the display name

getTheme

String getTheme()

Gets the theme for this report design.

Returns:

setTheme

void setTheme(String theme)
       throws ScriptException

Sets the theme for this report design.

Parameters:

theme -

Throws:

ScriptException

createHideRule

IHideRule createHideRule()

Create IHideRule instance

Returns:

IHideRule

createFilterCondition

IFilterCondition createFilterCondition()

Create IFilterCondition

Returns:

instance

createDataBinding

IDataBinding createDataBinding()

Create IDataBinding

Returns:

instance

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 handle

handle - the element handle that holds the action structure

Returns:

the action