jeters.core
Class UIRequest_Selection
java.lang.Object
jeters.core.UIRequest
jeters.core.UIRequest_Selection
public class UIRequest_Selection
- extends UIRequest
this subclass of UIRequest
is used when the user can choose between a limited number of possibilities.
As the result is an integer, a selection request resembles an integer-request with range_min and range_max set,
but it will look different for the user due to the names for every possible selection
(depending on the UI, of course).
Field Summary |
java.lang.String[] |
selectionNames
array of names for the selection; the result of the request will be the index of the selection. |
java.lang.Integer |
startingValue
the value that will initially be set and will be the result of the request unless the user changes it;
can be null (no specified starting value). |
Constructor Summary |
UIRequest_Selection(java.lang.String name,
java.lang.String label,
java.lang.String help,
java.lang.Integer startingValue,
java.lang.String[] selectionNames)
simple "this.xyz = xyz"-constructor, selectionNames is cloned. |
UIRequest_Selection(java.lang.String name,
java.lang.String label,
java.lang.String help,
java.lang.String[] selectionNames)
simple "this.xyz = xyz"-constructor, selectionNames is cloned, startingValue remains null; |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
selectionNames
public java.lang.String[] selectionNames
- array of names for the selection; the result of the request will be the index of the selection.
For a valid request, selectionNames must not be null and its size must not be 0.
startingValue
public java.lang.Integer startingValue
- the value that will initially be set and will be the result of the request unless the user changes it;
can be null (no specified starting value).
UIRequest_Selection
public UIRequest_Selection(java.lang.String name,
java.lang.String label,
java.lang.String help,
java.lang.Integer startingValue,
java.lang.String[] selectionNames)
- simple "this.xyz = xyz"-constructor, selectionNames is cloned.
UIRequest_Selection
public UIRequest_Selection(java.lang.String name,
java.lang.String label,
java.lang.String help,
java.lang.String[] selectionNames)
- simple "this.xyz = xyz"-constructor, selectionNames is cloned, startingValue remains null;
getType
public UIRequest.Type getType()
- returns the type of the request: Request_Selection.
- Specified by:
getType
in class UIRequest