org.universAAL.utilities.api.ui

Class Text

java.lang.Object

org.universAAL.utilities.api.ui.Control

org.universAAL.utilities.api.ui.InputControl

org.universAAL.utilities.api.ui.Text

Direct Known Subclasses:

Area

public class Text
extends InputControl

Class representing a Text Input UI element. Text Inputs get a textual value, whether it's written, spoken or any other way, depending on the UI renderer. The input is represented as a String.

Example render:

 Label[_initialValue_____]
 

Author:

alfiva

Field Summary

Fields

Modifier and Type	Field and Description
protected String	initialValue Initial value.

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
Text() Generic empty constructor.
Text(String ref) Constructor with the reference of the input to be used in request and response.
Text(String ref, String label) Constructor with the reference of the input to be used in request and response.
Text(String ref, String label, String initialValue) 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.
String	getInitialValue() Get the initial value of the input by default.
void	setInitialValue(String initialValue) Set the initial value of the input by default.

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

Field Detail

initialValue

protected String initialValue

Initial value.

Constructor Detail

Text

public Text()

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

Text

public Text(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 (empty). 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.

Text

public Text(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.

Text

public Text(String ref,
            String label,
            String initialValue)

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.

initialValue - The value the text input field has by default. If it is not changed by the user this will be the value of the input in the response.

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.

Specified by:

create in class Control

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.

getInitialValue

public String getInitialValue()

Get the initial value of the input by default.

Returns:

The initial value.

setInitialValue

public void setInitialValue(String initialValue)

Set the initial value of the input by default.

Parameters:

initialValue - The initial value.