|
||||||||||
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
org.eclipse.birt.report.model.api.CascadingParameterGroupHandle
public class CascadingParameterGroupHandle
Represents the group of cascading parameters. Cascading parameters are created under the group.
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.ICascadingParameterGroupModel |
---|
DATA_SET_MODE_PROP, DATA_SET_PROP, PROMPT_TEXT_ID_PROP, PROMPT_TEXT_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IParameterGroupModel |
---|
HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, PARAMETERS_SLOT, 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 | |
---|---|
CascadingParameterGroupHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.elements.CascadingParameterGroup element)
Constructs the handle for a group of cascading parameters with the given design and element. |
Method Summary | |
---|---|
DataSetHandle |
getDataSet()
Returns the handle for the data set defined on the cascading parameter group. |
java.lang.String |
getDataSetMode()
Gets the mode for data set support. |
java.lang.String |
getDisplayPromptText()
Returns the localized text for prompt text. |
java.lang.String |
getPromptText()
Gets the display prompt text. |
java.lang.String |
getPromptTextKey()
Returns the prompt text key. |
void |
setDataSet(DataSetHandle handle)
Sets the data set of the report item. |
void |
setDataSetMode(java.lang.String mode)
Sets the mode for data set support. |
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. |
Methods inherited from class org.eclipse.birt.report.model.api.ParameterGroupHandle |
---|
getHelpText, getHelpTextKey, getParameters, setHelpText, setHelpTextKey, setStartExpanded, startExpanded |
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 CascadingParameterGroupHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.elements.CascadingParameterGroup element)
module
- the moduleelement
- the cascading parameter group element instance.Method Detail |
---|
public DataSetHandle getDataSet()
public void setDataSet(DataSetHandle handle) throws SemanticException
handle
- the handle of the data set, if handle
is null,
data set property will be cleared.
SemanticException
- if the property is locked.public void setPromptText(java.lang.String promptValue) throws SemanticException
promptValue
- The display prompt context.
SemanticException
public java.lang.String getPromptText()
public void setDataSetMode(java.lang.String mode) throws SemanticException
DesignChoiceConstants.SINGLE_MODE
DesignChoiceConstants.MULTIPLE_MODE
mode
- either the single data set or multiple data set.
SemanticException
- if the input value is not one of above values.public java.lang.String getDataSetMode()
setDataSetMode(String)
public void setPromptTextKey(java.lang.String promptIDValue) throws SemanticException
promptIDValue
- The prompt text key.
SemanticException
public java.lang.String getPromptTextKey()
public java.lang.String getDisplayPromptText()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |