Class TemplateParameterDefinitionHandle

  • All Implemented Interfaces:
    org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.ITemplateParameterDefinitionModel

    public class TemplateParameterDefinitionHandle
    extends ReportElementHandle
    implements org.eclipse.birt.report.model.elements.interfaces.ITemplateParameterDefinitionModel
    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:
    • A required and unique name for this template parameter definition.
    • A type for this template parameter definition. It is the the enumeration of Table,Grid, Label, Text, ExtendedItem, other kind of report items and Dataset.
    • A static description message to display.
    The application generally does not create template parameter definition handles directly. Instead, BIRT will create it when users replace an actual report item or data set with a template element.
    • Constructor Detail

      • TemplateParameterDefinitionHandle

        public 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. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
        Parameters:
        module - the module
        element - the model representation of the element
    • Method Detail

      • getAllowedType

        public java.lang.String getAllowedType()
        Gets allowed type of the template parameter definition.
        Returns:
        the allowed type of the template parameter definition
      • setAllowedType

        public void setAllowedType​(java.lang.String type)
                            throws SemanticException
        Sets the allowed type of the template parameter definition.
        Parameters:
        type - the type to set
        Throws:
        SemanticException - if the property is locked
      • getDescription

        public java.lang.String getDescription()
        Returns the static description for the template parameter definition.
        Returns:
        the static description to display
      • getDisplayDescription

        public java.lang.String getDisplayDescription()
        Returns the localized description for the template parameter definition. If the localized description for the description resource key is found, it will be returned. Otherwise, the static description will be returned.
        Returns:
        the localized description for the template parameter definition
      • setDescription

        public void setDescription​(java.lang.String description)
                            throws SemanticException
        Sets the description of the template parameter definition. Sets the static description itself. If the template parameter definition is to be externalized, then set the description ID separately.
        Parameters:
        description - the new description for the template parameter definition
        Throws:
        SemanticException - if the property is locked.
      • getDescriptionKey

        public java.lang.String getDescriptionKey()
        Returns the resource key of the static description of the template parameter definition.
        Returns:
        the resource key of the static description
      • setDescriptionKey

        public void setDescriptionKey​(java.lang.String resourceKey)
                               throws SemanticException
        Sets the resource key of the static description of the template parameter definition.
        Parameters:
        resourceKey - the resource key of the static description
        Throws:
        SemanticException - if the property is locked.
      • getDefaultElement

        public DesignElementHandle getDefaultElement()
        Gets the default element of this template parameter definition.
        Returns:
        the default element of this template parameter definition