Class Index | File Index

Classes


Class CheckBox

represents check box
Defined in: raphaeltools.src.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
CheckBox(raphael, params)
Check box
Field Summary
Field Attributes Field Name and Description
 
dim
size of rectangle
 
if box is checked
 
x
x coordinate of top left corner
 
y
y coordinate of top left corner
Method Summary
Method Attributes Method Name and Description
 
check(b)
Check (or uncheck) receiver
<static>  
CheckBox.create(raphael, params)
Creates new CheckBox object, for parameters meaning see CheckBox
 
What to do when the box state is changed.
 
Uncheck receiver
 
Update receiver
Class Detail
CheckBox(raphael, params)
Check box
Parameters:
{Raphael} raphael
rapheal instance
{Object} params
parameters, see below
{float} params.x Optional, Default: 100.
x coordinate of left upper corner [pixel]
{float} params.y Optional, Default: 100.
y coordinate of left upper corner [pixel]
{float} params.dim Optional, Default: 20.
dimension of the box [pixel]
{bool} params.isChecked Optional, Default: false
if box is checked
{Object} params.rectAttrs Optional, Default: {}
box (rectangle) attrs passed to this.rect.attr
{Object} params.pathAttrs Optional, Default: {}
path (check) attrs passed to this.path.attr
Field Detail
{float} dim
size of rectangle

{bool} isChecked
if box is checked

{float} x
x coordinate of top left corner

{float} y
y coordinate of top left corner
Method Detail
check(b)
Check (or uncheck) receiver
Parameters:
{bool} b Optional, Default: true
bool value to be set

<static> {CheckBox} CheckBox.create(raphael, params)
Creates new CheckBox object, for parameters meaning see CheckBox
Parameters:
raphael
params
Returns:
{CheckBox} new CheckBox object

onchange()
What to do when the box state is changed. Initially empty function

uncheck()
Uncheck receiver

update()
Update receiver

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Dec 12 2012 09:22:03 GMT+0100 (CET)