CheckboxControl

A checkbox control.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, String

Hierarchy:

Superclass: Widget

Class: CheckboxControl

Property Listing

Property

Type

Access

Description

checkedState

Boolean

read/write

If true, the control is checked by default in the dialog.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the CheckboxControl.

index

Number

readonly

The index of the CheckboxControl within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

minWidth

Number

read/write

The width of the control. For an editbox or combobox, specifies the minimum width of the box.

parent

DialogRow

EnablingGroup

BorderPanel

DialogColumn

readonly

The parent of the CheckboxControl (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).

properties

Object

read/write

A property that allows setting of several properties at the same time.

staticLabel

String

read/write

Text that appears in the CheckboxControl.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

CheckboxControl getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the CheckboxControl.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

CheckboxControls.add()

CheckboxControl.getElements()

CheckboxControls.anyItem()

CheckboxControls.everyItem()

CheckboxControls.nextItem()

CheckboxControls.previousItem()

CheckboxControls.itemByID()

CheckboxControls.item()

CheckboxControls.[]()

CheckboxControls.itemByRange()

CheckboxControls.firstItem()

CheckboxControls.lastItem()

CheckboxControls.middleItem()