Namespaces

Class CKEDITOR.dialog.definition.textarea

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

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.dialog.definition.textarea() The definition of a text field (multiple lines).

Field Summary
Field Attributes	Field Name and Description
	cols The number of columns.
	default The default value.
	rows The number of rows.
	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.textarea()

Since: 3.0

The definition of a text field (multiple lines).

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

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.textarea 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 : 'textarea',
	id : 'message',
	label : 'Your comment',
	'default' : '',
	validate : function() {
		if ( this.getValue().length < 5 )
		{
			api.openMsgDialog( 'The comment is too short.' );
			return false;
		}
	}
}

Field Detail

{Number} cols

Since: 3.0

The number of columns.

{String} default

Since: 3.0

The default value.

{Number} rows

Since: 3.0

The number of rows.

{Function} validate

Since: 3.0

(Optional) The validation function.

CKEditor 3 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.dialog.definition.textarea