CKEditor 4 Documentation

CKEDITOR.ui.dialog.checkbox

Hierarchy

CKEDITOR.ui.dialog.uiElement
CKEDITOR.ui.dialog.checkbox

Files

A single checkbox with a label on the right.

Defined By

Properties

CKEDITOR.ui.dialog.checkbox
view source
: Object

Defines the onChange event for UI element definitions.

Defines the onChange event for UI element definitions.

Overrides: CKEDITOR.ui.dialog.uiElement.eventProcessors

Defined By

Methods

CKEDITOR.ui.dialog.checkbox
view source
new( dialog, elementDefinition, htmlList ) : CKEDITOR.ui.dialog.checkbox
Creates a checkbox class instance. ...

Creates a checkbox class instance.

Parameters

  • dialog : CKEDITOR.dialog

    Parent dialog window object.

  • elementDefinition : CKEDITOR.dialog.definition.uiElement

    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.
  • htmlList : Array

    List of HTML code to output to.

Returns

Overrides: CKEDITOR.ui.dialog.uiElement.constructor

The default handler for a UI element's access key down event, which tries to put focus to the UI element. ...

The default handler for a UI element's access key down event, which tries to put focus to the UI element.

Can be overridded in child classes for more sophisticaed behavior.

Parameters

  • dialog : CKEDITOR.dialog

    The parent dialog object.

  • key : String

    The key combination pressed. Since access keys are defined to always include the CTRL key, its value should always include a 'CTRL+' prefix.

CKEDITOR.ui.dialog.checkbox
view source
( )
Handler for the access key up event. ...

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

Overrides: CKEDITOR.ui.dialog.uiElement.accessKeyUp

Disables a UI element. ...

Disables a UI element.

Enables a UI element. ...

Enables a UI element.

Puts the focus to the UI object. ...

Puts the focus to the UI object. Switches tabs if the UI object isn't in the active tab page.

uiElement.focus();

Returns

Gets the parent dialog object containing this UI element. ...

Gets the parent dialog object containing this UI element.

var dialog = uiElement.getDialog();

Returns

Gets the root DOM element of this dialog UI object. ...

Gets the root DOM element of this dialog UI object.

uiElement.getElement().hide();

Returns

CKEDITOR.ui.dialog.checkbox
view source
( ) : CKEDITOR.dom.element
Gets the checkbox DOM element. ...

Gets the checkbox DOM element.

Returns

Overrides: CKEDITOR.ui.dialog.uiElement.getInputElement

CKEDITOR.ui.dialog.checkbox
view source
( ) : Boolean
Gets the state of the checkbox. ...

Gets the state of the checkbox.

Returns

  • Boolean

    true means that the checkbox is ticked, false means it is not ticked.

Overrides: CKEDITOR.ui.dialog.uiElement.getValue

Tells whether the UI object's value has changed. ...

Tells whether the UI object's value has changed.

if ( uiElement.isChanged() )
    confirm( 'Value changed! Continue?' );

Returns

  • Boolean

    true if changed, false if not changed.

Determines whether an UI element is enabled or not. ...

Determines whether an UI element is enabled or not.

Returns

  • Boolean

    Whether the UI element is enabled.

Determines whether an UI element is focus-able or not. ...

Determines whether an UI element is focus-able or not. Focus-able is defined as being both visible and enabled.

Returns

  • Boolean

    Whether the UI element can be focused.

Determines whether an UI element is visible or not. ...

Determines whether an UI element is visible or not.

Returns

  • Boolean

    Whether the UI element is visible.

Registers the on* event handlers defined in the element definition. ...

Registers the on* event handlers defined in the element definition.

The default behavior of this function is:

  1. If the on* event is defined in the class's eventProcesors list, then the registration is delegated to the corresponding function in the eventProcessors list.
  2. If the on* event is not defined in the eventProcessors list, then register the event handler under the corresponding DOM event of the UI element's input DOM element (as defined by the return value of getInputElement).

This function is only called at UI element instantiation, but can be overridded in child classes if they require more flexibility.

Parameters

Returns

Selects the parent tab of this element. ...

Selects the parent tab of this element. Usually called by focus() or overridden focus() methods.

focus : function() {
    this.selectParentTab();
    // do something else.
}

Returns

CKEDITOR.ui.dialog.checkbox
view source
( checked, noChangeEvent )
Sets the state of the checkbox. ...

Sets the state of the checkbox.

Parameters

  • checked : Boolean

    true to tick the checkbox, false to untick it.

  • noChangeEvent : Boolean

    Internal commit, to supress change event on this element.

Overrides: CKEDITOR.ui.dialog.uiElement.setValue

Defined By

Events

Fired when the value of the uiElement is changed. ...

Fired when the value of the uiElement is changed.

Parameters