|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportElement
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. |
java.lang.String |
getName()
Returns the name of this element. |
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. |
void |
setName(java.lang.String name)
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, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
---|
void setCustomXml(java.lang.String customXml) throws ScriptException
customXml
- the custom XML to set
ScriptException
- if the custom XML is locked or not defined on this element.java.lang.String getCustomXml()
void setComments(java.lang.String theComments) throws ScriptException
theComments
- the comments to set
ScriptException
- if the comments property is locked or not defined on this
element.java.lang.String getComments()
void setDisplayNameKey(java.lang.String displayNameKey) throws ScriptException
displayNameKey
- the resource key of the display name
ScriptException
- 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 ScriptException
displayName
- the display name
ScriptException
- if the display name property is locked or not defined on this
element.java.lang.String getDisplayName()
java.lang.String getName()
null
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.
void setName(java.lang.String name) throws ScriptException
null
, then
the name is cleared if this element does not require a name.
name
- the new name
ScriptException
- if the name is duplicate, or if the name is null
and this element requires a name.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |