Widget Checkbox
From eyeOS Wiki
Contents |
Introduction
Checkbox can be used whenever it's necessary to see if the value of a specific option has been selected or not.
Widget Use
Available Generic Keys
- horiz: specifies whether its horizontal coordinate must be taken from the left (0) or the right (1) border of its container element. Default is 0 (left).
- vert: specifies whether its vertical coordinate must be taken from the top (0) or from the bottom (1) border of its container element. Default is 0 (top).
- x: specifies the horizontal displacement inside its "father" element, in pixels. Default is 10 pixels.
- y: specifies the vertical displacement inside its "father" element, in pixels. Default is 10 pixels.
- cent: specifies how the widget should be centered. Possible values are:
- 0: no centering. This is the default value.
- 1: center both horizontal and vertically.
- 2: center horizontally.
- 3: center vertically.
- 4: place the widget at the horizontal and vertical center of its container element.
- 5: place the widget at the horizontal center of its container element.
- 6: place the widget at the vertical center of its container element.
Please note the difference between options 1-3 and options 4-6. Options 1-3 calculate the size of the widget to ensure that the center of the widget is placed at the central point of its container, while options 4-6 set the central point coordinates as the widget's position.
- visible: toggles the widget visibility. Possible values are 0 (hidden) or 1 (visible). Default value is 1.
- enabled: specifies whether the widget is enabled (usable) or not. Default value is 1 (enabled), while disabled value is 0.
Specific Keys
- text: sets the text shown with the Checkbox.
- checked: specifies whether the Checkbox will be activated (1) or not (0). Default value is 0.
Methods
addEvent($eventName,$eventFunc,$args = )
- Description: makes the widget execute code every time certain event is triggered.
- Arguments:
- eventName: the name of the JS event. Example: onchange.
- eventFunc: the JS code to be executed.
- args: if any, the args passed to the system.
check($num)
- Description: checks an option, unchecking the previously checked radio.
- Arguments:
- num: index of the radio control (starting with 0) to check.
disable()
- Description: makes the widget unusable.
- Arguments: none.
enable()
- Description: makes the widget usable.
- Arguments: none.
focus()
- Description: makes this widget as the selected one.
- Arguments: none.
hide()
- Description: makes the widget invisible.
- Arguments: none.
remove()
- Description: removes this widget, along with its child widgets.
- Arguments: none.
setCss($params)
- Description: sets CSS atributes to a widget.
- Arguments:
- params: specifies, in the form of an associative array, the CSS attributes to be applied. Remember that both the key and value of each element must be valid CSS properties and values respectively.
setValue($check)
- Description: changes the checked status of the Checkbox.
- Arguments:
- check: must be the string "true" to check the Checkbox. To uncheck it, it must have any other value.
setX($x)
- Description: changes the horizontal position of the widget.
- Arguments:
- x: natural number specifying the new X coordinate.
setY($y)
- Description: changes the vertical position of the widget.
- Arguments:
- y: natural number specifying the new Y coordinate.
uncheck($num)
- Description: unchecks an option.
- Arguments:
- num: index of the radio control (starting with 0) to uncheck.
unhide()
- Description: makes the widget visible.
- Arguments: none.
Can be serialized
Yes, Checkbox is always serialized by default. Remember that you can avoid to serialize it by passing number 1 as the argument to method show().
