CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.dialog.definitionObject

class private
See source

This class is not really part of the API. It is the definition property value passed to dialogDefinition event handlers.

CKEDITOR.on( 'dialogDefinition', function( evt ) {
    var definition = evt.data.definition;
    var content = definition.getContents( 'page1' );
        // ...
} );

Filtering

Properties

  • buttons : Array

    See source

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

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

  • contents : Array

    See source

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

  • since 3.5.3

    height : Number

    See source

    The initial height of the dialog, in pixels.

    Defaults to CKEDITOR.dialog.definition.minHeight

  • minHeight : Number

    See source

    The minimum height of the dialog, in pixels.

    Defaults to 400

  • minWidth : Number

    See source

    The minimum width of the dialog, in pixels.

    Defaults to 600

  • onCancel : Function

    See source

    The function to execute when the "Cancel" button is pressed.

  • onHide : Function

    See source

    The function executed every time the dialog is closed.

  • onLoad : Function

    See source

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

  • onOk : Function

    See source

    The function to execute when the "OK" button is pressed.

  • onShow : Function

    See source

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

  • resizable : Number

    See source

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

    Defaults to CKEDITOR.DIALOG_RESIZE_NONE

  • title : String

    See source

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

  • since 3.5.3

    width : Number

    See source

    The initial width of the dialog, in pixels.

    Defaults to CKEDITOR.dialog.definition#minWidth

Methods

  • constructor() → definitionObject

    See source

    Creates a definitionObject class instance.

    Returns

    definitionObject

  • addButton( buttonDefinition, [ nextSiblingId ] ) → button

    See source

    Adds a button definition object under this dialog definition.

    Parameters

    buttonDefinition : button

    The button definition.

    [ nextSiblingId ] : String

    The id of an existing button definition which the new button definition will be inserted before. Omit if the new button definition is to be inserted as the last item.

    Returns

    button

    The inserted button definition.

  • addContents( contentDefinition, [ nextSiblingId ] ) → content

    See source

    Adds a content definition object under this dialog definition.

    Parameters

    contentDefinition : content

    The content definition.

    [ nextSiblingId ] : String

    The id of an existing content definition which the new content definition will be inserted before. Omit if the new content definition is to be inserted as the last item.

    Returns

    content

    The inserted content definition.

  • getButton( id ) → button

    See source

    Gets a button definition.

    Parameters

    id : String

    The id of the button definition.

    Returns

    button

    The button definition matching id.

  • getContents( id ) → content

    See source

    Gets a content definition.

    Parameters

    id : String

    The id of the content definition.

    Returns

    content

    The content definition matching id.

  • since 4.13.0

    getMode( editor ) → Number

    See source

    Returns the current dialog mode based on the state of the feature used with this dialog.

    See CKEDITOR.dialog.EDITING_MODE and CKEDITOR.dialog.CREATION_MODE.

    Parameters

    editor : editor

    Returns

    Number

    Dialog mode.

  • since 4.13.0

    getModel( editor ) → element | widget | Object | null

    See source

    Returns the subject of the dialog.

    For most plugins, like the table or link plugin, it should return a DOM element instance if there is an element related to the dialog. For widget plugins (image2, placeholder) it should return a CKEDITOR.plugins.widget instance that is the subject of this dialog.

    Parameters

    editor : editor

    Returns

    element | widget | Object | null

    Returns null if the dialog does not use the model.

  • removeButton( id ) → button

    See source

    Removes a button definition from the dialog definition.

    Parameters

    id : String

    The id of the button definition to be removed.

    Returns

    button

    The removed button definition.

  • removeContents( id ) → content

    See source

    Removes a content definition from this dialog definition.

    Parameters

    id : String

    The id of the content definition to be removed.

    Returns

    content

    The removed content definition.