org.universAAL.utilities.api.ui

Class SelectOne

java.lang.Object

org.universAAL.utilities.api.ui.Control

org.universAAL.utilities.api.ui.InputControl

org.universAAL.utilities.api.ui.SelectMulti

org.universAAL.utilities.api.ui.SelectOne

public class SelectOne
extends SelectMulti

Class representing a Single-selection Input UI element. Single-selection Inputs get a single Object value from a list, whether it's a drop-down, 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 [_initialValue_|V]
       | val2         |
       | val3         |
       | val4         |
       |______________|
 

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.

Author:

alfiva

Field Summary

Fields inherited from class org.universAAL.utilities.api.ui.SelectMulti

initialValue

Fields inherited from class org.universAAL.utilities.api.ui.InputControl

model

Fields inherited from class org.universAAL.utilities.api.ui.Control

help, hint, label, MY_NAMESPACE, ref

Constructor Summary

Constructors

Constructor and Description
SelectOne() Generic empty constructor.
SelectOne(String ref) Constructor with the reference of the input to be used in request and response.
SelectOne(String ref, String label) Constructor with the reference of the input to be used in request and response.
SelectOne(String ref, String label, Object[] initialOptions) Constructor with the reference of the input to be used in request and response.

Method Summary

Modifier and Type	Method and Description
String[]	create(Group group) This method is for internal use of utils only.

Methods inherited from class org.universAAL.utilities.api.ui.SelectMulti

addOption, getInitialIndex, getOptions, setInitialIndex, setOptions

Methods inherited from class org.universAAL.utilities.api.ui.InputControl

getModel

Methods inherited from class org.universAAL.utilities.api.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

Constructor Detail

SelectOne

public SelectOne()

Generic empty constructor. The Input will be generated with default values (first).

SelectOne

public SelectOne(String ref)

Constructor with the reference of the input to be used in request and response. The reference is a property path, but in this constructor it is simplified as a single String (a single-property path). All other properties of the input are set to defaults (first). Use method setReference(String[] path) to set a path through several properties.

Parameters:

ref - The simple reference identifying the input. Set to null to auto-generate.

SelectOne

public SelectOne(String ref,
                 String label)

Constructor with the reference of the input to be used in request and response. The reference is a property path, but in this constructor it is simplified as a single String (a single-property path). Use method setReference(String[] path) to set a path through several properties.

Parameters:

ref - The simple reference identifying the input. Set to null to auto-generate.

label - The label text that identifies the input to the user.

SelectOne

public SelectOne(String ref,
                 String label,
                 Object[] initialOptions)

Constructor with the reference of the input to be used in request and response. The reference is a property path, but in this constructor it is simplified as a single String (a single-property path). All other properties of the input are set to defaults (first). Use method setReference(String[] path) to set a path through several properties.

Parameters:

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

create

public String[] create(Group group)

Description copied from class: Control

This method is for internal use of utils only. It creates the actual official universAAL control configured with the properties defined by this class. Once it is created it cannot be modified.

Overrides:

create in class SelectMulti

Parameters:

group - The UI group to which the control is being added.

Returns:

An array of Strings representing the property path used to identify the control in the response. This is only of interest for Input Controls. Submits and Triggers have only one String value. If the path has not been set manually by the time this method is called, an automatic one must be generated.