Namespaces

Class CKEDITOR.dialog.definition.radio

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

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.dialog.definition.radio() The definition of a radio group.

Field Summary
Field Attributes	Field Name and Description
	default The default value.
	items An array of options.
	validate (Optional) The validation function.

Fields borrowed from class CKEDITOR.dialog.definition.labeledElement:: controlStyle, inputStyle, label, labelLayout, labelStyle, widths
Fields borrowed from class CKEDITOR.dialog.definition.uiElement:: align, className, commit, id, onHide, onLoad, onShow, setup, style, title, type

Class Detail

CKEDITOR.dialog.definition.radio()

Since: 3.0

The definition of a radio group.

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

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.radio 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 : 'radio',
	id : 'country',
	label : 'Which country is bigger',
	items : [ [ 'France', 'FR' ], [ 'Germany', 'DE' ] ] ,
	style : 'color:green',
	'default' : 'DE',
	onClick : function() {
		// this = CKEDITOR.ui.dialog.radio
		alert( 'Current value: ' + this.getValue() );
	}
}

Field Detail

{String} default

Since: 3.0

The default value.

{Array} items

Since: 3.0

An array of options. Each option is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value' is missing, then the value would be assumed to be the same as the description.

{Function} validate

Since: 3.0

(Optional) The validation function.

CKEditor 3 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.dialog.definition.radio