CKEditor 4 Documentation

CKEDITOR.dialog.definition

Subclasses

Files

The definition of a dialog window.

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

// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

CKEDITOR.dialog.add( 'testOnly', function( editor ) {
    return {
        title:          'Test Dialog',
        resizable:      CKEDITOR.DIALOG_RESIZE_BOTH,
        minWidth:       500,
        minHeight:      400,
        contents: [
            {
                id:         'tab1',
                label:      'First Tab',
                title:      'First Tab Title',
                accessKey:  'Q',
                elements: [
                    {
                        type:           'text',
                        label:          'Test Text 1',
                        id:             'testText1',
                        'default':      'hello world!'
                    }
                ]
            }
        ]
    };
} );
Defined By

Properties

CKEDITOR.dialog.definition
view source
: Array
The buttons in the dialog, defined as an array of CKEDITOR.dialog.definition.button objects. ...

The buttons in the dialog, defined as an array of CKEDITOR.dialog.definition.button objects.

Defaults to: [ CKEDITOR.dialog.okButton, CKEDITOR.dialog.cancelButton ]

CKEDITOR.dialog.definition
view source
: Array
The contents in the dialog, defined as an array of CKEDITOR.dialog.definition.content objects. ...

The contents in the dialog, defined as an array of CKEDITOR.dialog.definition.content objects. Required.

CKEDITOR.dialog.definition
view source
: Number
The initial height of the dialog, in pixels. ...

The initial height of the dialog, in pixels.

Defaults to: CKEDITOR.dialog.definition.minHeight

Available since: 3.5.3

CKEDITOR.dialog.definition
view source
: Number
The minimum height of the dialog, in pixels. ...

The minimum height of the dialog, in pixels.

Defaults to: 400

CKEDITOR.dialog.definition
view source
: Number
The minimum width of the dialog, in pixels. ...

The minimum width of the dialog, in pixels.

Defaults to: 600

CKEDITOR.dialog.definition
view source
: Function

The function to execute when Cancel is pressed.

The function to execute when Cancel is pressed.

CKEDITOR.dialog.definition
view source
: Function

The function to execute when the dialog is displayed for the first time.

The function to execute when the dialog is displayed for the first time.

CKEDITOR.dialog.definition
view source
: Function

The function to execute when OK is pressed.

The function to execute when OK is pressed.

CKEDITOR.dialog.definition
view source
: Function

The function to execute when the dialog is loaded (executed every time the dialog is opened).

The function to execute when the dialog is loaded (executed every time the dialog is opened).

CKEDITOR.dialog.definition
view source
: Number
How the dialog can be resized, must be one of the four contents defined below. ...

How the dialog can be resized, must be one of the four contents defined below.

Defaults to: CKEDITOR.DIALOG_RESIZE_NONE

CKEDITOR.dialog.definition
view source
: String
The dialog title, displayed in the dialog's header. ...

The dialog title, displayed in the dialog's header. Required.

CKEDITOR.dialog.definition
view source
: Number
The initial width of the dialog, in pixels. ...

The initial width of the dialog, in pixels.

Defaults to: CKEDITOR.dialog.definition#minWidth

Available since: 3.5.3