Class CKEDITOR.ui.dialog.checkbox

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.ui.dialog.checkbox(dialog, elementDefinition, htmlList) A single checkbox with a label on the right.

Field Summary
Field Attributes	Field Name and Description
	eventProcessors Defines the onChange event for UI element definitions.

Method Summary
Method Attributes	Method Name and Description
	accessKeyUp() Handler for the access key up event.
	getInputElement() Gets the checkbox DOM element.
	getValue() Gets the state of the checkbox.
	setValue(true, noChangeEvent) Sets the state of the checkbox.

Methods borrowed from class CKEDITOR.ui.dialog.uiElement:: accessKeyDown, disable, enable, focus, getDialog, getElement, isChanged, isEnabled, isFocusable, isVisible, registerEvents, selectParentTab

Class Detail

CKEDITOR.ui.dialog.checkbox(dialog, elementDefinition, htmlList)

Since: 3.0

A single checkbox with a label on the right.

Parameters:

{CKEDITOR.dialog} dialog

Parent dialog object.

The element definition. Accepted fields:

checked (Optional) Whether the checkbox is checked on instantiation. Defaults to false.
validate (Optional) The validation function.
label (Optional) The checkbox label.

{Array} htmlList

List of HTML code to output to.

Field Detail

{Object} eventProcessors

Since: 3.0

Defines the onChange event for UI element definitions.

Method Detail

{Undefined} accessKeyUp()

Since: 3.0

Handler for the access key up event. Toggles the checkbox.

{CKEDITOR.dom.element} getInputElement()

Since: 3.0

Gets the checkbox DOM element.

{Boolean} getValue()

Since: 3.0

Gets the state of the checkbox.

Returns:: {Boolean} true means the checkbox is ticked, false means it's not ticked.

{Undefined} setValue(true, noChangeEvent)

Since: 3.0

Sets the state of the checkbox.

Parameters:
{Boolean} true: to tick the checkbox, false to untick it.
{Boolean} noChangeEvent: Internal commit, to supress 'change' event on this element.

CKEditor 3 JavaScript API Documentation