Class SelectionChoiceHandle
java.lang.Object
org.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.SelectionChoiceHandle
Represents the handle of selection choice. The selection choice is the value
and label pair for parameter.
- Value
- the data value for this choice. The value string is interpreted base on the parameter data type.
- Label
- a optional label to display for this value.
- Label Resource Key
- a optional label resource key when localiztion is needed.
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContext
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
Constructor Summary
ConstructorsConstructorDescriptionSelectionChoiceHandle
(SimpleValueHandle valueHandle, int index) Constructs the handle of selection choice. -
Method Summary
Modifier and TypeMethodDescriptiongetLabel()
Returns the label.Returns the resource key if label needs localization.getValue()
Returns the data value for this choice.void
Sets the label.void
setLabelKey
(String labelResourceKey) Sets the resource key if label needs localization.void
Sets the data value for this choice.Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Constructor Details
-
SelectionChoiceHandle
Constructs the handle of selection choice.- Parameters:
valueHandle
- the value handle for selection choice list of one propertyindex
- the position of this selection choice in the list
-
-
Method Details
-
getLabel
Returns the label.- Returns:
- the label
-
setLabel
Sets the label.- Parameters:
label
- the label to set
-
getLabelKey
Returns the resource key if label needs localization.- Returns:
- the resource key of label.
-
setLabelKey
Sets the resource key if label needs localization.- Parameters:
labelResourceKey
- the resource key to set
-
getValue
Returns the data value for this choice.- Returns:
- the data value for this choice
-
setValue
Sets the data value for this choice.- Parameters:
value
- the value to set- Throws:
SemanticException
- value required exception
-