Index...
Centrallix Documentation
|
widget/checkbox
checkbox :: Form element capable of selecting an on/off, yes/no, true/false, etc., type of value, via a visual 'check mark'.
Metadata:
| type: | widget/checkbox |
| visual: | yes |
| container: | no |
| form element: | yes |
Overview:
The checkbox widget is used to display a value that can be either true or false (or on/off, yes/no, etc.).It displays as a simple clickable check box.
Usage:
The checkbox widget can be placed inside of any visual container, and will attach itself to any form widget that contains it (whether directly or indirectly). Checkboxes may not contain visual widgets.
Properties:
| Property | Type | Description |
|---|
| checked |
yes/no |
whether this checkbox should be initially checked or not. Default 'no'. |
| fieldname |
string |
name of objectsource field that should be associated with this checkbox. |
| fl_width |
string |
? |
| form |
string |
The name of the form that this checkbox is associated with. |
| height |
integer |
The height of the check box widget in pixels. |
| readonly |
integer |
(e.g. readonly=yes). |
| width |
integer |
The width of the check box widget in pixels. |
| x |
integer |
x-coordinate of the upper left corner of the checkbox, default is 0. |
| y |
integer |
y-coordinate of the upper left corner of the checkbox, default is 0. |
Child Properties:
none currently available
Actions:
none currently available
Events:
| Event | Description |
|---|
| Click |
This event occurs when the user clicks the checkbox. No parameters are available from this event. |
| MouseUp |
This event occurs when the user releases the mouse button on the checkbox. |
| MouseDown |
This event occurs when the user presses the mouse button on the checkbox. This differs from the 'Click' event in that the user must actually press and release the mouse button on the checkbox for a Click event to fire, whereas simply pressing the mouse button down will cause the MouseDown event to fire. |
| MouseOver |
This event occurs when the user first moves the mouse pointer over the checkbox. It will not occur again until the user moves the mouse off of the checkbox and then back over it again. |
| MouseOut |
This event occurs when the user moves the mouse pointer off of the checkbox. |
| MouseMove |
This event occurs when the user moves the mouse pointer while it is over the checkbox. The event will repeatedly fire each time the pointer moves. |
| DataChange |
This event occurs when the user has modified the data value of the checkbox (clicked or unclicked it). |
Client Properties:
none currently available
Sample Code:
$Version=2$
// Here are two checkboxes.
checkbox_test "widget/page"
{
background="/sys/images/slate2.gif";
testcheck2 "widget/checkbox"
{
x = 20; y = 40;
}
testcheck "widget/checkbox"
{
x = 20; y = 20;
}
}
Comments...
(none yet)
Add a Comment...
|
