Code Index | File Index



Class CKEDITOR.dialog.definition.checkbox

Extends CKEDITOR.dialog.definition.uiElement.
Defined in: plugins/dialog/dialogDefinition.js.

Class Summary
Constructor Attributes Constructor Name and Description
The definition of a checkbox element.
Field Summary
Field Attributes Field Name and Description
The default state.
The label of the UI element.
(Optional) The validation function.
Fields borrowed from class CKEDITOR.dialog.definition.uiElement:
align, className, commit, id, onHide, onLoad, onShow, setup, style, title, type
Class Detail
Since: 3.0
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() );
Field Detail
{String} default
Since: 3.0
The default state.
Default Value:
'' (unchecked)

{String} label
Since: 3.0
The label of the UI element.

{Function} validate
Since: 3.0
(Optional) The validation function.

Copyright © 2003-2010, CKSource - Frederico Knabben. All rights reserved.