public abstract class TemplateElementHandle extends ReportElementHandle
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
element
module
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator
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 elementpublic 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 elementSemanticException
- 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 descriptionSemanticException
- if the property is locked.public DesignElementHandle getDefaultElement()
public IDesignElement copyDefaultElement()
Copyright © 2008 Actuate Corp. All rights reserved.