EnumControlprovides control over a set of discrete possible values, each represented by an object. In a graphical user interface, such a control might be represented by a set of buttons, each of which chooses one value or setting. For example, a reverb control might provide several preset reverberation settings, instead of providing continuously adjustable parameters of the sort that would be represented by
Controls that provide a choice between only two settings can often be
implemented instead as a
BooleanControl, and controls that provide a
set of values along some quantifiable dimension might be implemented instead
FloatControl with a coarse resolution. However, a key feature of
EnumControl is that the returned values are arbitrary objects, rather
than numerical or boolean values. This means that each returned object can
provide further information. As an example, the settings of a
REVERB control are instances of
ReverbType that can be queried for the parameter values used for each
Nested Class SummaryModifier and TypeClassDescription
static classAn instance of the
EnumControl.Typeinner class identifies one kind of enumerated control.
Method SummaryModifier and TypeMethodDescription
getValue()Obtains this control's current value.
ObjectReturns the set of possible values for this control.
voidSets the current value for the control.
toString()Returns a string representation of the enumerated control.
EnumControlConstructs a new enumerated control object with the given parameters.
type- the type of control represented this enumerated control object
values- the set of possible values for the control
value- the initial control value
setValuepublic void setValue
(Object value)Sets the current value for the control. The default implementation simply sets the value as indicated. If the value indicated is not supported, an
IllegalArgumentExceptionis thrown. Some controls require that their line be open before they can be affected by setting a value.
value- the desired new value
IllegalArgumentException- if the value indicated does not fall within the allowable range
getValuepublic Object getValue()Obtains this control's current value.
- the current value
getValuespublic Object getValues()Returns the set of possible values for this control.
- the set of possible values
toStringpublic String toString()Returns a string representation of the enumerated control.