Class: com.ibm.dse.gui.SpComboBox
Extends: java.swing.JComboBox
Implements:
com.ibm.dse.gui.DataExchanger
The SpComboBox class has the following
properties:
- alternativeDataName: A data element name defined in the context. It is
of type String.
- BeansReactions: A class name. When a bean changes states and the end state
is a non-error state, the bean will call the beanReaction(java.awt.Component)
static method of the specified class.
- colors: Allows different colors for mandatory, background, or foreground,
etc., to be specified, overriding those defined settings.
- helpId: Identifier for the online help function. The help text associated
with this property is shown when the Help key is pressed. If this property
is not defined, the HelpId of the panel where the button is located is used.
If that panel's helpId property is not defined, the parent panels are searched
recursively until the property is found or the DSECoordinatedPanel is reached.
If the helpID value is not found at the DSECoordinatedPanel, null is used.
This property can also be defined in the dataElement descriptor (the name
of this descriptor is helpID). If it is defined in the view, this value will
be the helpId property value.
- dataNameForList: A data collection (keyed or indexed) name defined in
the context or operation context. Values in the collection must be defined
as String. If the data collection is a keyed collection and you intend to
use keys as values in the list, they must also be defined as String. If the
list values for the combo box are not in the context and must be obtained
in a different way (for example, they are defined in a DB2(R) table), you must use the setListElements(Vector)public
method, passing as an argument a Vector of Strings, representing the values
of each list item.
- dataName: A data element name defined in the context or operation context.
It is of type String.
- dataToClear: Clears the data exchangers according to the value in the
dataDirection property, which can be Input, Output, or Both. Applicable to
the Clear button type.
- mandatory: Boolean. If true, the combo requires a selected item. This
property can also be defined in the dataElement descriptor. If it is defined
in the model (context or operation context), this value will be the "mandatory"
property value (the name of this descriptor is isMandatory).
- navigationParameters: An object that contains properties to facilitate
navigation between views. (For more information about this object see NavigationParameters
object description.) Only the properties that are needed for the specified
type are significant (see the type property, below).
- dataDirection: Specifies the direction in which a consistency check is
made between the associated data element and the bean. Following are the possible
values:
- Input: When the combo box is selected, the data element in dataName associated
with the bean is updated.
- Output: When the data element in dataName associated with the bean changes,
the combo box is updated.
- Both: Both the Input and Output behaviors occur.
- type: Specifies the type of the combo box. Possible values are Default,
OK, Clear, Close, Repeat, Euro, EMUCurrency, Help, Previous View, Next View,
Undo, Cancel, Open View, None, and Execute Operation.
- useKeyValues: Boolean. If true, the combo box list contains the keys of
the collection; otherwise, it contains the values of the collection. If the
dataNameForList property contains an IndexedCollection, then keys will be
the index.
- valueInContext: Specifies which data to set in the context. Following
are the possible values:
- value: The context contains the values of the collections.
- id: The context contains the keys of the collections.