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

CKEDITOR.dialog.definition.checkbox

class
See source

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() );
    }
}

Filtering

Properties

  • align : String

    See source

    Horizontal alignment (in the container) of the UI element.

  • className : String

    See source

    CSS class names to append to the UI element.

  • commit : Function

    See source

    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.

  • default : String

    See source

    The default state.

    Defaults to '' (unchecked)

  • id : String

    See source

    The ID of the UI element.

  • label : String

    See source

    The label of the UI element.

  • onHide : Function

    See source

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

  • onLoad : Function

    See source

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

  • onShow : Function

    See source

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

  • requiredContent : String | Object | style

    See source

    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.

  • setup : Function

    See source

    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.

  • style : String

    See source

    Inline CSS classes to append to the UI element.

  • title : String

    See source

    The popup label of the UI element.

  • type : String

    See source

    The type of the UI element. Required.

  • validate : Function

    See source

    (Optional) The validation function.