The gateway user interface can use a number of widgets to provide the user interface, these generally are active components that are used to display date from the gateway and to issue commands to the gateway. They are put into the kid templates using custom xml tags, the reason for this is so that the user interface can degrade gracefully, i.e. if the browser does not support javascript they can be rendered using static data and the whole page refreshed. Some widgets are display only and some are input as well as display. See additional document on the flash interface for developers wishing to create there own flash assets.
General attributes
These attributes are all optional. The rowspan nd colspan attributes are likely to go as the td elements should not be held within the widget but be prt of the surrounding layout.
- height - mainly needed for image and flash displays
- width - mainly needed for image and flash displays
- rowspan - number of table rows to span - NOT IN widgets.kid
- colspan - number of table columns to span
- baseClassName - Change the base CSS class name for the widget.
Links
This type of widget generally provides a link to another page.
- target - where the link goes when clicked.
simpleLink
This widget uses either a href or an onclick handler to provide the link.
- colspan - number of table columns to span
- navBarSmall
Simple display
A simple display element, i.e. indicator, only has a single interface variable a state variable. This is delivered by specification using the wbSource attribute in the KID template.
- wbSource - state of the indicator.
textDisplay
This type of widget displays text retrieved from the gateway.
- prefix - fixed prefix for the return value.
- postfix - fixed postfix for the return value.
- width - override natural width of element
- colspan - number of table columns to span
- textPresent
- textPending
- textAbsent
imageIndicator
This type of widget expects a single numeric value that is used to select one a small number of configured images to be displayed.
- imageBase - Base URL for images
- imageList - comma separated list of images, these should be relative to imageBase.
caption
This type of widget displays a pre configured text string. Default Css class(s).
- caption
Analogue display
An analogue display element, i.e. meter, has an interface variable that controls. This is delivered by specification using the wbSource attribute in the KID template.
- wbSource - value for meter.
numericDisplay
This type of widget formats and displays a numeric value retrieved from the gateway.
- prefix - fixed prefix for the return value.
- postfix - fixed postfix for the return value.
- format - format specifier for the number.
- width - override natural width of element
- colspan - number of table columns to span
- numericPending
- numericInfo
- numericAbsent
flashMeter
This type of widget formats and displays a numeric value retrieved from the gateway using a small flash movie. See also section on creating flash assets.
- prefix - fixed prefix for the return value.
- postfix - fixed postfix for the return value.
- format - format specifier for the number.
- width - override natural width of element
- colspan - number of table columns to span
- minvalue
- maxvalue
- setlow
- sethigh
- labels
- metertitle
- flashMovie
- FlashMeter
Digital control
A digital control element, i.e. button, has a state number and a trigger target. This is delivered by specification using the wbSource attribute in the KID template.
- wbSource - state of the indicator.
- wbTarget - url to be accessed when the control is activated.
simpleButton
This widget optionally shows a simple state and enables the user to trigger a change.
- format - format specifier for the number.
- width - override natural width of element
- height - override natural height of element
- colspan - number of table columns to span
- baseClassName - CSS classes are derived from this by adding the current state.
- stateVals - contains a comma separated list of strings that are apended to CSS class to get the CSS class to be used for each of the wbSource state values. The defaults are Off and On
- buttonPending
- buttonAbsent
- buttonOff
- buttonOn
- button<stateVals>
flashButton
This widget uses a small flash movie to enable the user to control.
- labels
- flashMovie
- FlashButton
Analogue control
An analogue control element, i.e. volume control, has an interface variable that controls. This is delivered by specification using the wbSource attribute in the KID template.
- wbSource - value for meter.
- wbTarget - url to be accessed when the control is changed.
numericEntry
This type of widget formats and displays a numeric value retrieved from the gateway, and enables the user to enter a new value that is sent to the gateway. This type of widget formats and displays a numeric value retrieved from the gateway.
- prefix - fixed prefix for the return value.
- postfix - fixed postfix for the return value.
- format - format specifier for the number.
- width - override natural width of element
- colspan - number of table columns to span
- numericPending
- numericInfo
- numericAbsent
flashNumericEntry
This type of widget formats and displays a numeric value retrieved from the gateway, and enables the user to enter a new value that is sent to the gateway.
Time controls
These controls are used to display and manipulate time.
timeDisplay
This type of widget formats and displays a time value retrieved from the gateway.
- width - override natural width of element
- colspan - number of table columns to span
- numericInfo
- numericPending
timeEntry
This type of widget formats and displays a time value retrieved from the gateway, and enables the user to enter a new time that is sent to the gateway.
- title - Title for the entry dialog.
- width - override natural width of element
- colspan - number of table columns to span
- wbTarget - Target URL fr the new value, the value will be appended to this URL.
- numericInfo
- numericPending
- numericAbsent
Miscellaneous
These controls are used to display and manipulate time.
onoffEntry
This widget is specific to a schedule and displays the action for a simple on off device and enables the user to enter a new setting.
- title - Title for the entry dialog.
- width - override natural width of element
- colspan - number of table columns to span
- wbTarget - Target URL fr the new value, the value will be appended to this URL.
- baseClassName - CSS classes are derived from this by adding the current state.
- WbOnOffEntry<state>
dayEntry
This widget is specific to a schedule and displays the days of the week that a scheduled event occurs and enables the user to enter a new set of days.
- title - Title for the entry dialog.
- width - override natural width of element
- colspan - number of table columns to span
- wbTarget - Target URL fr the new value, the value will be appended to this URL.
- numericInfo
- numericPending
- numericAbsent