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

All Superinterfaces:
IDesignElement
All Known Subinterfaces:
ICell, IDataItem, IDynamicText, IGrid, IGroup, IImage, ILabel, IList, IListGroup, IReportItem, IRow, ITable, ITableGroup, ITextItem

public interface IReportElement
extends IDesignElement

Represents a the design of a report element in the scripting environment


Method Summary
 java.lang.String getComments()
          Gets the comments of the report element.
 java.lang.String getCustomXml()
          Gets the custom XML.
 java.lang.String getDisplayName()
          Gets the display name.
 java.lang.String getDisplayNameKey()
          Gets the resource key of the display name.
 void setComments(java.lang.String theComments)
          Sets the comments of the report element.
 void setCustomXml(java.lang.String customXml)
          Sets the custom XML.
 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
getName, getNamedExpression, getParent, getQualifiedName, getStyle, getUserProperty, setName, setNamedExpression, setUserProperty, setUserProperty
 

Method Detail

setCustomXml

public void setCustomXml(java.lang.String customXml)
                  throws ScriptException
Sets the custom XML.

Parameters:
customXml - the custom XML to set
Throws:
ScriptException - if the custom XML is locked or not defined on this element.

getCustomXml

public java.lang.String getCustomXml()
Gets the custom XML.

Returns:
the custom XML

setComments

public void setComments(java.lang.String theComments)
                 throws ScriptException
Sets the comments of the report element.

Parameters:
theComments - the comments to set
Throws:
ScriptException - if the comments property is locked or not defined on this element.

getComments

public java.lang.String getComments()
Gets the comments of the report element.

Returns:
the comments of the report element

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


Copyright © 2005 Actuate Corp. All rights reserved.