CKEDITOR.dialog.definitionObject

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

Properties

• buttons : ArrayCKEDITOR.dialog.definitionObject#buttons

  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 : ArrayCKEDITOR.dialog.definitionObject#contents

  See source

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

• since 3.5.3

  height : NumberCKEDITOR.dialog.definitionObject#height

  See source

  The initial height of the dialog, in pixels.

  Defaults to CKEDITOR.dialog.definition.minHeight

• minHeight : NumberCKEDITOR.dialog.definitionObject#minHeight

  See source

  The minimum height of the dialog, in pixels.

  Defaults to 400

• minWidth : NumberCKEDITOR.dialog.definitionObject#minWidth

  See source

  The minimum width of the dialog, in pixels.

  Defaults to 600

• onCancel : FunctionCKEDITOR.dialog.definitionObject#onCancel

  See source

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

• onHide : FunctionCKEDITOR.dialog.definitionObject#onHide

  See source

  The function executed every time the dialog is closed.

• onLoad : FunctionCKEDITOR.dialog.definitionObject#onLoad

  See source

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

• onOk : FunctionCKEDITOR.dialog.definitionObject#onOk

  See source

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

• onShow : FunctionCKEDITOR.dialog.definitionObject#onShow

  See source

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

• resizable : NumberCKEDITOR.dialog.definitionObject#resizable

  See source

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

  • CKEDITOR.DIALOG_RESIZE_NONE
  • CKEDITOR.DIALOG_RESIZE_WIDTH
  • CKEDITOR.DIALOG_RESIZE_HEIGHT
  • CKEDITOR.DIALOG_RESIZE_BOTH

  Defaults to CKEDITOR.DIALOG_RESIZE_NONE

• title : StringCKEDITOR.dialog.definitionObject#title

  See source

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

• since 3.5.3

  width : NumberCKEDITOR.dialog.definitionObject#width

  See source

  The initial width of the dialog, in pixels.

  Defaults to CKEDITOR.dialog.definition#minWidth

Methods

• constructor() → definitionObjectCKEDITOR.dialog.definitionObject#constructor

  See source

  Creates a definitionObject class instance.

  Returns

  definitionObject

• addButton( buttonDefinition, [ nextSiblingId ] ) → buttonCKEDITOR.dialog.definitionObject#addButton

  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 ] ) → contentCKEDITOR.dialog.definitionObject#addContents

  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 ) → buttonCKEDITOR.dialog.definitionObject#getButton

  See source

  Gets a button definition.

  Parameters

  id : String

  The id of the button definition.

  Returns

  button

  The button definition matching id.

• getContents( id ) → contentCKEDITOR.dialog.definitionObject#getContents

  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 ) → NumberCKEDITOR.dialog.definitionObject#getMode

  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 | nullCKEDITOR.dialog.definitionObject#getModel

  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 ) → buttonCKEDITOR.dialog.definitionObject#removeButton

  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 ) → contentCKEDITOR.dialog.definitionObject#removeContents

  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.