|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportDesign
Script wrapper of ReportDesignHandle
Method Summary | |
---|---|
IDataItem |
getDataItem(java.lang.String name)
method to get a data item by name |
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)
Gets master page script instance. |
IReportElement |
getReportElement(java.lang.String name)
generic method to get report item by name |
IReportElement |
getReportElementByID(long id)
generic method to get report item by id |
ITable |
getTable(java.lang.String name)
method to get a table item by name |
ITextItem |
getTextItem(java.lang.String name)
method to get a text item by name |
java.lang.String |
getTheme()
Gets the theme for this report design. |
void |
save()
Saves the module to an existing file name. |
void |
saveAs(java.lang.String newName)
Saves the design to the file name provided. |
void |
setDisplayName(java.lang.String displayName)
Sets the display name. |
void |
setDisplayNameKey(java.lang.String displayNameKey)
Sets the resource key of the display name. |
void |
setTheme(java.lang.String theme)
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, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
---|
IMasterPage getMasterPage(java.lang.String name)
name
-
IDataSet getDataSet(java.lang.String name)
name
-
IDataSource getDataSource(java.lang.String name)
name
-
IReportElement getReportElement(java.lang.String name)
name
-
ILabel getLabel(java.lang.String name)
name
-
IGrid getGrid(java.lang.String name)
name
-
IImage getImage(java.lang.String name)
name
-
IList getList(java.lang.String name)
name
-
ITable getTable(java.lang.String name)
name
-
IDynamicText getDynamicText(java.lang.String name)
name
-
IDataItem getDataItem(java.lang.String name)
name
-
ITextItem getTextItem(java.lang.String name)
name
-
void setDisplayNameKey(java.lang.String displayNameKey) throws SemanticException
displayNameKey
- the resource key of the display name
SemanticException
- if the display name resource-key property is locked or not
defined on this element.java.lang.String getDisplayNameKey()
void setDisplayName(java.lang.String displayName) throws SemanticException
displayName
- the display name
SemanticException
- if the display name property is locked or not defined on this
element.java.lang.String getDisplayName()
void save() throws java.io.IOException
java.io.IOException
- if the file cannot be saved on the storage. Or the file name
is not valid.saveAs(String)
void saveAs(java.lang.String newName) throws java.io.IOException
save( )
will save to this
new name.
newName
- the new file name
java.io.IOException
- if the file cannot be saved. Or the file name is not valid.save()
java.lang.String getTheme()
void setTheme(java.lang.String theme) throws SemanticException
theme
-
SemanticException
IReportElement getReportElementByID(long id)
name
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |