|
||||||||||
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.TemplateParameterDefinitionHandle
public class TemplateParameterDefinitionHandle
Represents a template parameter definition element. A template parameter definitio gives a definition of a template element. It can be referred by one template report item or one template data set. The template parameter definition has the following properties:
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.ITemplateParameterDefinitionModel |
---|
ALLOWED_TYPE_PROP, DEFAULT_SLOT, DESCRIPTION_ID_PROP, DESCRIPTION_PROP, NAME_PROP, SLOT_COUNT |
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 | |
---|---|
TemplateParameterDefinitionHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for the given design and design element. |
Method Summary | |
---|---|
java.lang.String |
getAllowedType()
Gets allowed type of the template parameter definition. |
DesignElementHandle |
getDefaultElement()
Gets the default element of this template parameter definition. |
java.lang.String |
getDescription()
Returns the static description for the template parameter definition. |
java.lang.String |
getDescriptionKey()
Returns the resource key of the static description of the template parameter definition. |
java.lang.String |
getDisplayDescription()
Returns the localized description for the template parameter definition. |
void |
setAllowedType(java.lang.String type)
Sets the allowed type of the template parameter definition. |
void |
setDescription(java.lang.String description)
Sets the description of the template parameter definition. |
void |
setDescriptionKey(java.lang.String resourceKey)
Sets the resource key of the static description of the template parameter definition. |
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 TemplateParameterDefinitionHandle(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 void setAllowedType(java.lang.String type) throws SemanticException
type
- the type to set
SemanticException
- if the property is lockedpublic 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 parameter definition
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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |