CKEDITOR.dialog.definitionObject
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
CKEDITOR.dialog.definitionObject#buttons
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
CKEDITOR.dialog.definitionObject#contents
The contents in the dialog, defined as an array of CKEDITOR.dialog.definition.content objects. Required.
-
height : Number
CKEDITOR.dialog.definitionObject#height
since 3.5.3
The initial height of the dialog, in pixels.
Defaults to
CKEDITOR.dialog.definition.minHeight
-
minHeight : Number
CKEDITOR.dialog.definitionObject#minHeight
The minimum height of the dialog, in pixels.
Defaults to
400
-
minWidth : Number
CKEDITOR.dialog.definitionObject#minWidth
The minimum width of the dialog, in pixels.
Defaults to
600
-
onCancel : Function
CKEDITOR.dialog.definitionObject#onCancel
The function to execute when the "Cancel" button is pressed.
-
onHide : Function
CKEDITOR.dialog.definitionObject#onHide
The function executed every time the dialog is closed.
-
onLoad : Function
CKEDITOR.dialog.definitionObject#onLoad
The function to execute when the dialog is displayed for the first time.
-
onOk : Function
CKEDITOR.dialog.definitionObject#onOk
The function to execute when the "OK" button is pressed.
-
onShow : Function
CKEDITOR.dialog.definitionObject#onShow
The function to execute when the dialog is loaded (executed every time the dialog is opened).
-
resizable : Number
CKEDITOR.dialog.definitionObject#resizable
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 : String
CKEDITOR.dialog.definitionObject#title
The dialog title, displayed in the dialog's header. Required.
-
width : Number
CKEDITOR.dialog.definitionObject#width
since 3.5.3
The initial width of the dialog, in pixels.
Defaults to
CKEDITOR.dialog.definition#minWidth
Methods
-
constructor() → definitionObject
CKEDITOR.dialog.definitionObject#constructor
Creates a definitionObject class instance.
Returns
-
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
CKEDITOR.dialog.definitionObject#addContents
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.
-
Gets a button definition.
Parameters
id : String
The id of the button definition.
Returns
button
The button definition matching id.
-
getContents( id ) → content
CKEDITOR.dialog.definitionObject#getContents
Gets a content definition.
Parameters
id : String
The id of the content definition.
Returns
content
The content definition matching id.
-
getMode( editor ) → Number
CKEDITOR.dialog.definitionObject#getMode
since 4.13.0
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.
-
getModel( editor ) → element | widget | Object | null
CKEDITOR.dialog.definitionObject#getModel
since 4.13.0
Returns the subject of the dialog.
For most plugins, like the
table
orlink
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
-
removeButton( id ) → button
CKEDITOR.dialog.definitionObject#removeButton
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
CKEDITOR.dialog.definitionObject#removeContents
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.