public class UDControl
extends java.lang.Object
Such as Power, Status, SetPoint.
Each control may have some permissible actions
associated with it which is captured in this same class as a Hashtable of
UDAction
s.
Modifier and Type | Field and Description |
---|---|
java.util.Hashtable<java.lang.String,UDAction> |
actions
UDAction s associated to this control |
java.lang.String |
desc
The description if any
|
boolean |
isGlobal
Whether or not this is a control which applies
to ALL the linked devices
|
boolean |
isGUI
Whether or not this control should pop up on the GUI.
|
boolean |
isNumeric
Whether or not the values of this control are numeric
|
boolean |
isReadOnly
Whether or not this control is read only (such as status)
|
java.lang.String |
label
The label if any
|
java.lang.String |
max
The maximum possible value for this control
|
java.lang.String |
min
The minimum possible value for this control
|
java.lang.String |
name
The name of this control as used to communicate with ISY
|
java.lang.String |
numericUnit
The String representation of numeric units
|
int |
widgetType
The type of widget to be used for presentation purposes
Unused
|
Constructor and Description |
---|
UDControl()
Constructor
|
UDControl(XMLElement c)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
addWidget(java.lang.Object view,
com.universaldevices.ui.widgets.UDWidget widget)
This method is used by UD Administrative Console
|
com.universaldevices.ui.widgets.UDWidget |
getFirstWidget()
This method is used by UD Administrative Console
|
java.util.Iterator<UDAction> |
getSortedActionsIterator() |
com.universaldevices.ui.widgets.UDWidget |
getWidget(java.lang.Object view)
This method is used by UD Administrative Console
|
public java.util.Hashtable<java.lang.String,UDAction> actions
UDAction
s associated to this controlpublic boolean isGlobal
public boolean isGUI
public int widgetType
public java.lang.String min
public java.lang.String max
public java.lang.String name
public java.lang.String desc
public java.lang.String label
public boolean isReadOnly
public boolean isNumeric
public java.lang.String numericUnit
If the values are numeric, the String representation of the numeric unit such as F, C, %, etc.
public UDControl()
public UDControl(XMLElement c)
The constructor is called internally based on the configuration (XML) retrieved from the device (ISY). This class should not be used independently of the underlying UD Network and Services Layers
c
- public java.util.Iterator<UDAction> getSortedActionsIterator()
public com.universaldevices.ui.widgets.UDWidget getWidget(java.lang.Object view)
It maps a widget (a GUI representation of a control)
to the UDControl
view
- - the view where this widget is attached topublic void addWidget(java.lang.Object view, com.universaldevices.ui.widgets.UDWidget widget)
It adds a widget (a GUI representation of a control)
to the UDControl
view
- - the view where this widget is attached towidget
- - the widgetpublic com.universaldevices.ui.widgets.UDWidget getFirstWidget()
It gets the first ever widget (a GUI representation of a control)
which was associated to this UDControl