CKEDITOR.dialog.definition.textInput

The definition of a text field (single line).

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

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.textInput 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.

{
    type: 'text',
    id: 'name',
    label: 'Your name',
    'default': '',
    validate: function() {
        if ( !this.getValue() ) {
            api.openMsgDialog( '', 'Name cannot be empty.' );
            return false;
        }
    }
}