|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
public abstract class ReportElementHandle
Abstract base class for working with all elements except the report design. A report element can defines property masks for its property. A property mask says how to hide or lock an BIRT ERD-defined or developer-defined property.
Field Summary | |
---|---|
protected org.eclipse.birt.report.model.core.DesignElement |
element
The target report element. |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
ReportElementHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs the handle for a report element with the given design and element. |
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. |
org.eclipse.birt.report.model.core.DesignElement |
getElement()
Returns the element to which this handle is attached. |
java.lang.String |
getPropertyMask(java.lang.String propName)
Returns the mask of the specified property given its internal name. |
boolean |
isValidLayoutForCompoundElement()
Checks whether the compound element is valid. |
boolean |
isValidReferenceForCompoundElement()
Deprecated. |
java.util.Iterator |
propertyMaskIterator()
Returns property masks on 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 |
setPropertyMask(java.lang.String propName,
java.lang.String maskValue)
Sets the mask of the specified property. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.eclipse.birt.report.model.core.DesignElement element
Constructor Detail |
---|
public ReportElementHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public org.eclipse.birt.report.model.core.DesignElement getElement()
DesignElementHandle
getElement
in class DesignElementHandle
public java.util.Iterator propertyMaskIterator()
getPropertyMask(String)
public java.lang.String getPropertyMask(java.lang.String propName)
null
is returned if no mask value defined on this
property.
The optional mask values are defined in
DesignChoiceConstants.
and they are
PROPERTYMASK_TYPE_CHANGE
PROPERTYMASK_TYPE_LOCK
PROPERTYMASK_TYPE_HIDE
propName
- the name of the property to get. Can be a system-defined or
user-defined property name.
DesignChoiceConstants
public void setPropertyMask(java.lang.String propName, java.lang.String maskValue) throws SemanticException
DesignChoiceConstants
and they are:
PROPERTYMASK_TYPE_CHANGE
PROPERTYMASK_TYPE_LOCK
PROPERTYMASK_TYPE_HIDE
Note it is not allowed to set the mask on
PROPERTY_MASKS_PROP
. This method does nothing for this
situation.
propName
- the property name to get. Can be a system-defined or
user-defined property name.maskValue
- the mask value
SemanticException
- if the maskValue is not one of the above.DesignChoiceConstants
public 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.public java.lang.String getDisplayNameKey()
public 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.public java.lang.String getDisplayName()
public void setCustomXml(java.lang.String customXml) throws SemanticException
customXml
- the custom XML to set
SemanticException
- if the custom XML is locked or not defined on this element.public java.lang.String getCustomXml()
public void setComments(java.lang.String theComments) throws SemanticException
theComments
- the comments to set
SemanticException
- if the comments property is locked or not defined on this
element.public java.lang.String getComments()
public boolean isValidReferenceForCompoundElement()
true
if the compound element is valid. Otherwise
false
.public boolean isValidLayoutForCompoundElement()
true
if the compound element is valid. Otherwise
false
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |