|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.universAAL.support.utils.ui.Control
org.universAAL.support.utils.ui.InputControl
org.universAAL.support.utils.ui.SelectMulti
public class SelectMulti
Class representing a Multi-selection Input UI element. Multi-selection Inputs get one or many Object values from a list, whether it's a list of checkboxes, sorted column or any other way, depending on the UI renderer. The input is represented as the same type of Object stored in the list.
Example render:
Label | val1 | |[ val2 ]| |[ val3 ]| | val4 | | val5 |
The Objects in the list are displayed in a textual form by trying to convert them to a readable String, by using their .toString() method or their URI if they are Resources. When retrieving the input, remember to cast to the appropriate original type of Object.
Field Summary | |
---|---|
protected Integer |
initialValue
Initial selected index. |
Fields inherited from class org.universAAL.support.utils.ui.InputControl |
---|
model |
Fields inherited from class org.universAAL.support.utils.ui.Control |
---|
help, hint, label, MY_NAMESPACE, ref |
Constructor Summary | |
---|---|
SelectMulti()
Generic empty constructor. |
|
SelectMulti(String ref)
Constructor with the reference of the input to be used in request and response. |
|
SelectMulti(String ref,
String label)
Constructor with the reference of the input to be used in request and response. |
|
SelectMulti(String ref,
String label,
Object[] initialOptions)
Constructor with the reference of the input to be used in request and response. |
Method Summary | |
---|---|
void |
addOption(Object option)
Add an option to the list of possible options. |
String[] |
create(Group group)
This method is for internal use of utils only. |
Integer |
getInitialIndex()
Get the initial value of the selection as an index in the array of options. |
Object[] |
getOptions()
Get the possible options to select. |
void |
setInitialIndex(Integer initialIndex)
Set the initial value of the selection as the index in the array of options. |
void |
setOptions(Object[] options)
Get the possible options to select. |
Methods inherited from class org.universAAL.support.utils.ui.InputControl |
---|
getModel |
Methods inherited from class org.universAAL.support.utils.ui.Control |
---|
getHelp, getHint, getLabel, getReference, setHelp, setHint, setLabel, setReference, setReference |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Integer initialValue
Constructor Detail |
---|
public SelectMulti()
public SelectMulti(String ref)
ref
- The simple reference identifying the input. Set to null to
auto-generate.public SelectMulti(String ref, String label)
ref
- The simple reference identifying the input. Set to null to
auto-generate.label
- The label text that identifies the input to the user.public SelectMulti(String ref, String label, Object[] initialOptions)
ref
- The simple reference identifying the input. Set to null to
auto-generate.label
- The label text that identifies the input to the user.initialOptions
- An array of Objects that represent the different possible
options to select.Method Detail |
---|
public String[] create(Group group)
Control
create
in class Control
group
- The UI group to which the control is being added.
public Integer getInitialIndex()
public void setInitialIndex(Integer initialIndex)
initialIndex
- The index of the initial valuepublic Object[] getOptions()
public void addOption(Object option)
option
- The option to addpublic void setOptions(Object[] options)
options
- The array of Strings representing the different options to
select
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |