|
||||||||||
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
org.eclipse.birt.report.model.api.TemplateElementHandle
public abstract class TemplateElementHandle
Abstract handle for template elements. A template element is a place holder
to generate a real report item or data set element. Application reads the
default element of it by method getDefaultElement()
and clone a new
report item or data set based on the default element. Then application can
make some changes about the cloned element, such as set some property values,
add some contents, delete some contents. Now, application can use the cloned
element with changes or with no change to transform this place holder and get
a real report item or data set.
TemplateReportItemHandle
,
TemplateDataSetHandle
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
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 | |
---|---|
TemplateElementHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs the handle for a report item with the given design and element. |
Method Summary | |
---|---|
IDesignElement |
copyDefaultElement()
Returns a copy for the default element in the template element. |
java.lang.String |
getAllowedType()
Gets allowed type of the template element. |
DesignElementHandle |
getDefaultElement()
Gets the default element of this template element. |
java.lang.String |
getDescription()
Returns the static description for the template element. |
java.lang.String |
getDescriptionKey()
Returns the resource key of the static description of the template element. |
java.lang.String |
getDisplayDescription()
Returns the localized description for the template element. |
void |
setDescription(java.lang.String description)
Sets the description of the template element. |
void |
setDescriptionKey(java.lang.String resourceKey)
Sets the resource key of the static description of the template element. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TemplateElementHandle(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 java.lang.String getAllowedType()
public java.lang.String getDescription()
public java.lang.String getDisplayDescription()
public void setDescription(java.lang.String description) throws SemanticException
description
- the new description for the template element
SemanticException
- if the property is locked.public java.lang.String getDescriptionKey()
public void setDescriptionKey(java.lang.String resourceKey) throws SemanticException
resourceKey
- the resource key of the static description
SemanticException
- if the property is locked.public DesignElementHandle getDefaultElement()
public IDesignElement copyDefaultElement()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |