Class ParameterGroupHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IParameterGroupModel
Direct Known Subclasses:
CascadingParameterGroupHandleImpl

public class ParameterGroupHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IParameterGroupModel
Represents a group of parameters. A parameter group creates a visual grouping of parameters.
See Also:
  • ParameterGroup
  • Constructor Details

    • ParameterGroupHandle

      public ParameterGroupHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Constructs the handle for a group parameters with the given design and 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 Details

    • getParameters

      public SlotHandle getParameters()
      Returns a slot handle to work with the parameters within the parameter group.
      Returns:
      a handle for working with the parameters in this group
      See Also:
    • getHelpText

      public String getHelpText()
      Returns additional pop-up help text associated with the group.
      Returns:
      the help text
    • setHelpText

      public void setHelpText(String text) throws SemanticException
      Returns additional pop-up help text associated with the group.
      Parameters:
      text - the help text
      Throws:
      SemanticException - if the help text property is locked.
    • getHelpTextKey

      public String getHelpTextKey()
      Returns the resource key of the help text for this parameter group.
      Returns:
      the resource key of the help text
    • setHelpTextKey

      public void setHelpTextKey(String text) throws SemanticException
      Sets the resource key of the help text for this parameter group.
      Parameters:
      text - the resource key of the help text
      Throws:
      SemanticException - if the resource-key of the help text property is locked.
    • startExpanded

      public boolean startExpanded()
      Tests whether the UI can expand and collapse groups.
      Returns:
      true if can expand, otherwise false.
    • setStartExpanded

      public void setStartExpanded(boolean value) throws SemanticException
      Sets whether the UI can expand and collapse groups.
      Parameters:
      value - true if can expand, false not.
      Throws:
      SemanticException - if the property is locked.
    • getPromptText

      public String getPromptText()
      Gets the display prompt text.
      Returns:
      the display prompt.
    • getPromptTextKey

      public String getPromptTextKey()
      Returns the prompt text key.
      Returns:
      the prompt text key.
    • setPromptText

      public void setPromptText(String promptValue) throws SemanticException
      Sets the value for the display prompt context.
      Parameters:
      promptValue - The display prompt context.
      Throws:
      SemanticException
    • setPromptTextKey

      public void setPromptTextKey(String promptIDValue) throws SemanticException
      Set the value for the prompt text key.
      Parameters:
      promptIDValue - The prompt text key.
      Throws:
      SemanticException