CKEditor 4 Documentation

CKEDITOR.dialog.definition.checkbox

Hierarchy

CKEDITOR.dialog.definition.uiElement
CKEDITOR.dialog.definition.checkbox

Files

The definition of a checkbox element.

This class is not really part of the API. It just illustrates the properties that developers can use to define and create groups of checkbox buttons.

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.checkbox object and can be accessed with CKEDITOR.dialog.getContentElement.

For a complete example of dialog definition, please check CKEDITOR.dialog.add.

// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

// Example:
{
    type: 'checkbox',
    id: 'agree',
    label: 'I agree',
    'default': 'checked',
    onClick: function() {
        // this = CKEDITOR.ui.dialog.checkbox
        alert( 'Checked: ' + this.getValue() );
    }
}
Defined By

Properties

Horizontal alignment (in container) of the UI element.

Horizontal alignment (in container) of the UI element.

CSS class names to append to the UI element.

CSS class names to append to the UI element.

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.commitContent method is executed. ...

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.commitContent method is executed. It usually takes care of the respective UI element as a standalone element.

CKEDITOR.dialog.definition.checkbox
view source
: String
The default state. ...

The default state.

Defaults to: '' (unchecked)

The id of the UI element.

The id of the UI element.

CKEDITOR.dialog.definition.checkbox
view source
: String

The label of the UI element.

The label of the UI element.

Function to execute whenever the UI element's parent dialog is closed.

Function to execute whenever the UI element's parent dialog is closed.

Function to execute the first time the UI element is displayed.

Function to execute the first time the UI element is displayed.

Function to execute whenever the UI element's parent dialog is displayed.

Function to execute whenever the UI element's parent dialog is displayed.

The content that needs to be allowed to enable this UI element. ...

The content that needs to be allowed to enable this UI element. All formats accepted by CKEDITOR.filter.check may be used.

When all UI elements in a tab are disabled, this tab will be disabled automatically.

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.setupContent method is executed. ...

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.setupContent method is executed. It usually takes care of the respective UI element as a standalone element.

Inline CSS classes to append to the UI element.

Inline CSS classes to append to the UI element.

The popup label of the UI element.

The popup label of the UI element.

The type of the UI element. ...

The type of the UI element. Required.

CKEDITOR.dialog.definition.checkbox
view source
: Function

(Optional) The validation function.

(Optional) The validation function.