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
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
The contents in the dialog, defined as an array of CKEDITOR.dialog.definition.content objects. Required.
-
height : Number
since 3.5.3
The initial height of the dialog, in pixels.
Defaults to
CKEDITOR.dialog.definition.minHeight
-
minHeight : Number
The minimum height of the dialog, in pixels.
Defaults to
400
-
minWidth : Number
The minimum width of the dialog, in pixels.
Defaults to
600
-
onCancel : Function
The function to execute when Cancel is pressed.
-
onHide : Function
The function executed every time the dialog is closed.
-
onLoad : Function
The function to execute when the dialog is displayed for the first time.
-
onOk : Function
The function to execute when OK is pressed.
-
onShow : Function
The function to execute when the dialog is loaded (executed every time the dialog is opened).
-
resizable : Number
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
The dialog title, displayed in the dialog's header. Required.
-
width : Number
since 3.5.3
The initial width of the dialog, in pixels.
Defaults to
CKEDITOR.dialog.definition#minWidth
Methods
-
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
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
Gets a content definition.
Parameters
id : String
The id of the content definition.
Returns
content
The content definition matching id.
-
removeButton( id ) → button
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
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.