org.universAAL.utilities.api.ui

Class Out

java.lang.Object

org.universAAL.utilities.api.ui.Control

org.universAAL.utilities.api.ui.Out

public class Out
extends Control

Class representing a Text Output UI element. Text Output show a textual value, whether it's displayed, played or any other way, depending on the UI renderer. The output is represented as a String.

Example render:

 Label Value
 

Author:

alfiva

Field Summary

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

help, hint, label, MY_NAMESPACE, ref

Constructor Summary

Constructors

Constructor and Description
Out() Generic empty constructor.
Out(String value) Constructor with the output value.
Out(String label, String value) Constructor with the output value.
Out(String ref, String label, String value) Constructor with the reference of the output to be used in request.

Method Summary

Modifier and Type	Method and Description
String[]	create(Group group) This method is for internal use of utils only.
String	getValue() Get the output value to be displayed.
void	setValue(String value) Set the output value to be displayed.

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

Out

public Out()

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

Out

public Out(String value)

Constructor with the output value. All other properties of the input are set to defaults (empty).

Parameters:

value - The output value to be displayed.

Out

public Out(String label,
           String value)

Constructor with the output value.

Parameters:

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

value - The output value to be displayed.

Out

public Out(String ref,
           String label,
           String value)

Constructor with the reference of the output to be used in request. The reference is a property path, but in this constructor it is simplified as a single String (a single-property path). For outputs, references are only used in conjunction with initial root Resources. 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 output to the user.

value - The output value to be displayed.

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.

getValue

public String getValue()

Get the output value to be displayed.

Returns:

The output value

setValue

public void setValue(String value)

Set the output value to be displayed.

Parameters:

value - The output value