Interface IReportElement
-
- All Superinterfaces:
IDesignElement
- All Known Subinterfaces:
IAutoText,IDataItem,IDynamicText,IExtendedItem,IGrid,IImage,ILabel,IList,IListing,IMasterPage,IMultiRowItem,IReportItem,ITable,ITextItem
- All Known Implementing Classes:
MultiRowItem,SimpleRowItem
public interface IReportElement extends IDesignElement
Represents a the design of a report element in the scripting environment
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetComments()Gets the comments of the report element.java.lang.StringgetCustomXml()Gets the custom XML.java.lang.StringgetDisplayName()Gets the display name.java.lang.StringgetDisplayNameKey()Gets the resource key of the display name.java.lang.StringgetName()Returns the name of this element.voidsetComments(java.lang.String theComments)Sets the comments of the report element.voidsetCustomXml(java.lang.String customXml)Sets the custom XML.voidsetDisplayName(java.lang.String displayName)Sets the display name.voidsetDisplayNameKey(java.lang.String displayNameKey)Sets the resource key of the display name.voidsetName(java.lang.String name)Sets the name of this element.-
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
-
-
-
-
Method Detail
-
setCustomXml
void setCustomXml(java.lang.String customXml) throws SemanticExceptionSets the custom XML.- Parameters:
customXml- the custom XML to set- Throws:
SemanticException- if the custom XML is locked or not defined on this element.
-
getCustomXml
java.lang.String getCustomXml()
Gets the custom XML.- Returns:
- the custom XML
-
setComments
void setComments(java.lang.String theComments) throws SemanticExceptionSets the comments of the report element.- Parameters:
theComments- the comments to set- Throws:
SemanticException- if the comments property is locked or not defined on this element.
-
getComments
java.lang.String getComments()
Gets the comments of the report element.- Returns:
- the comments of the report element
-
setDisplayNameKey
void setDisplayNameKey(java.lang.String displayNameKey) throws SemanticExceptionSets the resource key of the display name.- Parameters:
displayNameKey- the resource key of the display name- Throws:
SemanticException- if the display name resource-key property is locked or not defined on this element.
-
getDisplayNameKey
java.lang.String getDisplayNameKey()
Gets the resource key of the display name.- Returns:
- the resource key of the display name
-
setDisplayName
void setDisplayName(java.lang.String displayName) throws SemanticExceptionSets the display name.- Parameters:
displayName- the display name- Throws:
SemanticException- if the display name property is locked or not defined on this element.
-
getDisplayName
java.lang.String getDisplayName()
Gets the display name.- Returns:
- the display name
-
getName
java.lang.String getName()
Returns the name of this element. Returnsnullif 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
void setName(java.lang.String name) throws SemanticExceptionSets 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:
SemanticException- if the name is duplicate, or if the name isnulland this element requires a name.
-
-