CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.ui.dialog.checkbox

class
See source

A single checkbox with a label on the right.

Filtering

Properties

  • eventProcessors : Object

    Defines the onChange event for UI element definitions.

    See source

Methods

  • constructor( dialog, elementDefinition, htmlList ) → checkbox

    Creates a checkbox class instance.

    See source

    Parameters

    dialog : dialog

    Parent dialog window object.

    elementDefinition : 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

    checkbox

  • accessKeyDown( dialog, key )

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

    See source

    Can be overridded in child classes for more sophisticaed behavior.

    Parameters

    dialog : 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.

  • accessKeyUp()

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

    See source

  • disable()

    Disables a UI element.

    See source

  • enable()

    Enables a UI element.

    See source

  • focus() → uiElement

    chainable

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

    See source
    uiElement.focus();

    Returns

    uiElement

    this

  • getDialog() → dialog

    Gets the parent dialog object containing this UI element.

    See source
    var dialog = uiElement.getDialog();

    Returns

    dialog

    Parent dialog object.

  • getElement() → element

    Gets the root DOM element of this dialog UI object.

    See source
    uiElement.getElement().hide();

    Returns

    element

    Root DOM element of UI object.

  • getInputElement() → element

    Gets the checkbox DOM element.

    See source

    Returns

    element

    The DOM element of the checkbox.

  • getValue() → Boolean

    Gets the state of the checkbox.

    See source

    Returns

    Boolean

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

  • isChanged() → Boolean

    Tells whether the UI object's value has changed.

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

    Returns

    Boolean

    true if changed, false if not changed.

  • isEnabled() → Boolean

    Determines whether an UI element is enabled or not.

    See source

    Returns

    Boolean

    Whether the UI element is enabled.

  • isFocusable() → Boolean

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

    See source

    Returns

    Boolean

    Whether the UI element can be focused.

  • isVisible() → Boolean

    Determines whether an UI element is visible or not.

    See source

    Returns

    Boolean

    Whether the UI element is visible.

  • registerEvents( definition ) → uiElement

    chainable

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

    See source

    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

    definition : uiElement

    The UI element definition.

    Returns

    uiElement

    this

  • selectParentTab() → uiElement

    chainable

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

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

    Returns

    uiElement

    this

  • setValue( checked, noChangeEvent )

    Sets the state of the checkbox.

    See source

    Parameters

    checked : Boolean

    true to tick the checkbox, false to untick it.

    noChangeEvent : Boolean

    Internal commit, to supress change event on this element.

Events

  • change( evt )

    Fired when the value of the uiElement is changed.

    See source

    Parameters

    evt : eventInfo