Class CKFinder.ui.dialog.checkbox

Extends CKFinder.ui.dialog.uiElement.

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

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(checked) Sets the state of the checkbox.

Methods borrowed from class CKFinder.ui.dialog.uiElement:: disable, enable, focus, getDialog, getElement, isChanged, isEnabled, isVisible, selectParentTab

Class Detail

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

Since: 2.0

A single checkbox with a label on the right.

Note: the whole CKFinder.ui.dialog namespace is not directly accessible (CKFinder.ui.dialog is undefined).
Instances of this class are created by CKFinder when dialog is created.

To add a checkbox to a dialog, check CKFinder.dialog.definition.checkbox.

Parameters:

{CKFinder.dialog} dialog

Parent dialog object.

{CKFinder.dialog.uiElementDefinition} elementDefinition

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.

Method Detail

{Undefined} accessKeyUp()

Since: 2.0

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

{CKFinder.dom.element} getInputElement()

Since: 2.0

Gets the checkbox DOM element.

Returns:: {CKFinder.dom.element} The DOM element of the checkbox.

{Boolean} getValue()

Since: 2.0

Gets the state of the checkbox.

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

{Undefined} setValue(checked)

Since: 2.0

Sets the state of the checkbox.

Parameters:
{Boolean} checked: true to tick the checkbox, false to untick it.

CKFinder 2 JavaScript API Documentation

Namespaces

Classes

Class CKFinder.ui.dialog.checkbox