public class ParameterGroupHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IParameterGroupModel
ParameterGroup
element
module
HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, PARAMETERS_SLOT, PROMPT_TEXT_ID_PROP, PROMPT_TEXT_PROP, START_EXPANDED_PROP
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 |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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 ParameterGroupHandle(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 SlotHandle getParameters()
SlotHandle
public java.lang.String getHelpText()
public void setHelpText(java.lang.String text) throws SemanticException
text
- the help textSemanticException
- if the help text property is locked.public java.lang.String getHelpTextKey()
public void setHelpTextKey(java.lang.String text) throws SemanticException
text
- the resource key of the help textSemanticException
- if the resource-key of the help text property is locked.public boolean startExpanded()
true
if can expand, otherwise false
.public void setStartExpanded(boolean value) throws SemanticException
value
- true
if can expand, false
not.SemanticException
- if the property is locked.public java.lang.String getPromptText()
public java.lang.String getPromptTextKey()
public void setPromptText(java.lang.String promptValue) throws SemanticException
promptValue
- The display prompt context.SemanticException
public void setPromptTextKey(java.lang.String promptIDValue) throws SemanticException
promptIDValue
- The prompt text key.SemanticException
Copyright © 2008 Actuate Corp. All rights reserved.