org.universAAL.support.utils.ui
Class TriggerCmd
java.lang.Object
org.universAAL.support.utils.ui.Control
org.universAAL.support.utils.ui.SubmitCmd
org.universAAL.support.utils.ui.TriggerCmd
public class TriggerCmd
- extends SubmitCmd
Class representing a SubDialog TriggerCmd UI element. Triggers are commands that
can be issued by the user, whether it's a button, spoken command or any other
way, depending on the UI renderer. Triggers differ from Submits in that they
can lead to SubDialogs without closing previous dialogs, which normal Submits
do.
Example render:
[Label]
- Author:
- alfiva
Constructor Summary |
TriggerCmd()
Generic empty constructor. |
TriggerCmd(String ref)
Constructor with the reference of the trigger to be used in request and
response. |
TriggerCmd(String ref,
String label)
Constructor with the reference of the trigger 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 |
TriggerCmd
public TriggerCmd()
- Generic empty constructor. The TriggerCmd will be generated with default
values (empty).
TriggerCmd
public TriggerCmd(String ref)
- Constructor with the reference of the trigger to be used in request and
response. The reference is a single ID String. All other properties of
the input are set to defaults (empty).
- Parameters:
ref
- The simple reference identifying the input. Set to null to
auto-generate.
TriggerCmd
public TriggerCmd(String ref,
String label)
- Constructor with the reference of the trigger to be used in request and
response. The reference is a single ID String.
- Parameters:
ref
- The simple reference identifying the input. Set to null to
auto-generate.label
- The label text that identifies the trigger to the user.
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 SubmitCmd
- 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.