PERGOLA LOGO

pergola.CheckBox

System events: YES.

User events and functions: YES (function only).

Example.

Listed: class properties/methods; prototype properties and methods; instance properties. Prototype properties and methods inherited by the Class superclass are not listed.

class

None

prototype

PROPERTIES

parent

pergola.user. Unless you need an orphan check-box, this property should normally be overridden to designate the container of the object requesting the instance.

width

Defined in pergola.presentationAttributes – number (user space units).

height

Defined in pergola.presentationAttributes – number (user space units).

fill

Defined in pergola.presentationAttributes – string.

checked

false – boolean.

METHODS

handleEvent(evt)

If this fn, the function is invoked through this checkUserFunction().

If this owner and this owner.fn, the function is invoked (exception. Note that the type of owner.fn cannot be a string).

build(object)

this inherits the properties specified in object. Prototype properties specified in object are overridden. Creates elements. Returns this.

If object specifies owner, the checked array property of this owner is defined if it doesn't exist, enabling the state of multiple check-marks to be monitored by owner. CheckBox instances specifying the same owner belong to the same (abstract) group. See Panel With Radio Buttons And Check Boxes in tutorial for this mechanism.

instance

name

String. If not passed to the constructor, gets a generated XML name (Class).

id

String. The return value of this name.toXML(). This container ID. Used as prefix where other elements' IDs are attributed.

owner

If specified, designates the owner object.

container

<g> element.

checkmark

<path> (“checkmark” symbol element).

manager

if specified, object for sibling check-boxes management.

caption

If specified, an object defining the required textNode string property, optional x, y number (user space units) properties, and optional position string property. These are pergola.Caption properties. This property is reassigned during processing, and references a new pergola.Caption instance.

fn

Callback function. Note: specified user events are ignored.