CKEDITOR.dialog.definition.checkbox

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