|
||||||||||
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.ParameterGroupHandle
public class ParameterGroupHandle
Represents a group of parameters. A parameter group creates a visual grouping of parameters.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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 elementMethod Detail |
---|
public SlotHandle getParameters()
SlotHandle
public java.lang.String getHelpText()
public void setHelpText(java.lang.String text) throws SemanticException
text
- the help text
SemanticException
- 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 text
SemanticException
- 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |