org.universAAL.support.utils.ui
Class Area
java.lang.Object
org.universAAL.support.utils.ui.Control
org.universAAL.support.utils.ui.InputControl
org.universAAL.support.utils.ui.Text
org.universAAL.support.utils.ui.Area
public class Area
- extends Text
Class representing a Text Area Input UI element. Text Area Inputs get an
usually long 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
Constructor Summary |
Area()
Generic empty constructor. |
Area(String ref)
Constructor with the reference of the input to be used in request and
response. |
Area(String ref,
String label)
Constructor with the reference of the input to be used in request and
response. |
Area(String ref,
String label,
String initialValue)
Constructor with the reference of the input to be used in request and
response. |
Method Summary |
String[] |
create(Group group)
This method is for internal use of utils only. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Area
public Area()
- Generic empty constructor. The Input will be generated with default
values (empty).
Area
public Area(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.
Area
public Area(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.
Area
public Area(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.
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 uaal control configured with the properties defined by this
class. Once it is created it cannot be modified.
- Overrides:
create
in class Text
- 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.
Copyright © 2014 universAAL Consortium. All Rights Reserved.