Interface IReportElement
- All Superinterfaces:
IDesignElement
- All Known Subinterfaces:
IAutoText
,IDataItem
,IDynamicText
,IGrid
,IImage
,ILabel
,IList
,IListing
,IMasterPage
,IReportItem
,ITable
,ITextItem
Represents a the design of a report element in the scripting environment
-
Method Summary
Modifier and TypeMethodDescriptionGets the comments of the report element.Gets the custom XML.Gets the display name.Gets the resource key of the display name.getName()
Returns the name of this element.void
setComments
(String theComments) Sets the comments of the report element.void
setCustomXml
(String customXml) Sets the custom XML.void
setDisplayName
(String displayName) Sets the display name.void
setDisplayNameKey
(String displayNameKey) Sets the resource key of the display name.void
Sets the name of this element.Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
-
Method Details
-
setCustomXml
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
String getCustomXml()Gets the custom XML.- Returns:
- the custom XML
-
setComments
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
String getComments()Gets the comments of the report element.- Returns:
- the comments of the report element
-
setDisplayNameKey
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
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
-
getName
String getName()Returns the name of this element. Returnsnull
if the element does not have a name. Many elements do not require a name. The name does not inherit. If this element does not have a name, it will not inherit the name of its parent element.- Returns:
- the element name, or null if the name is not set
-
setName
Sets the name of this element. If the name isnull
, then the name is cleared if this element does not require a name.- Parameters:
name
- the new name- Throws:
ScriptException
- if the name is duplicate, or if the name isnull
and this element requires a name.
-