Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api
Class ParameterGroupHandle

    java.lang.Object
      org.eclipse.birt.report.model.api.DesignElementHandle
          org.eclipse.birt.report.model.api.ReportElementHandle
              org.eclipse.birt.report.model.api.ParameterGroupHandle

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

Direct Known Subclasses:
  CascadingParameterGroupHandle

    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`

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.IParameterGroupModel
`HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, PARAMETERS_SLOT, PROMPT_TEXT_ID_PROP, PROMPT_TEXT_PROP, START_EXPANDED_PROP`

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
`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.

Method Summary
`java.lang.String` | `getHelpText()` Returns additional pop-up help text associated with the group.
`java.lang.String` | `getHelpTextKey()` Returns the resource key of the help text for this parameter group.
`SlotHandle` | `getParameters()` Returns a slot handle to work with the parameters within the parameter group.
`java.lang.String` | `getPromptText()` Gets the display prompt text.
`java.lang.String` | `getPromptTextKey()` Returns the prompt text key.
`void` | `setHelpText(java.lang.String text)` Returns additional pop-up help text associated with the group.
`void` | `setHelpTextKey(java.lang.String text)` Sets the resource key of the help text for this parameter group.
`void` | `setPromptText(java.lang.String promptValue)` Sets the value for the display prompt context.
`void` | `setPromptTextKey(java.lang.String promptIDValue)` Set the value for the prompt text key.
`void` | `setStartExpanded(boolean value)` Sets whether the UI can expand and collapse groups.
`boolean` | `startExpanded()` Tests whether the UI can expand and collapse groups.

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 org.eclipse.birt.report.model.api.DesignElementHandle
`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, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setEncryption, setEventHandlerClass, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### 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 Detail

### 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:
    `SlotHandle`

### getHelpText

    public java.lang.String getHelpText()

  Returns additional pop-up help text associated with the group.

  Returns:
    the help text

### setHelpText

    public void setHelpText(java.lang.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 java.lang.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(java.lang.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 java.lang.String getPromptText()

  Gets the display prompt text.

  Returns:
    the display prompt.

### getPromptTextKey

    public java.lang.String getPromptTextKey()

  Returns the prompt text key.

  Returns:
    the prompt text key.

### setPromptText

    public void setPromptText(java.lang.String promptValue)
                       throws SemanticException

  Sets the value for the display prompt context.

  Parameters:
    `promptValue` - The display prompt context.
  Throws:
    `SemanticException`

### setPromptTextKey

    public void setPromptTextKey(java.lang.String promptIDValue)
                          throws SemanticException

  Set the value for the prompt text key.

  Parameters:
    `promptIDValue` - The prompt text key.
  Throws:
    `SemanticException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.