Class CKEDITOR.dialog.definitionObject

Extends CKEDITOR.dialog.definition.
Defined in: plugins/dialog/plugin.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.dialog.definitionObject() This class is not really part of the API.

Fields borrowed from class CKEDITOR.dialog.definition:: buttons, contents, height, minHeight, minWidth, onCancel, onLoad, onOk, onShow, resizable, title, width

Method Summary
Method Attributes	Method Name and Description
	addButton(buttonDefinition, nextSiblingId) Adds a button definition object under this dialog definition.
	addContents(contentDefinition, nextSiblingId) Adds a content definition object under this dialog definition.
	getButton(id) Gets a button definition.
	getContents(id) Gets a content definition.
	removeButton(id) Removes a button definition from the dialog definition.
	removeContents(id) Removes a content definition from this dialog definition.

Class Detail

CKEDITOR.dialog.definitionObject()

Since: 3.0

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' );
		...
	} );

Method Detail

{CKEDITOR.dialog.definition.button} addButton(buttonDefinition, nextSiblingId)

Since: 3.0

Adds a button definition object under this dialog definition.

NO EXAMPLE AVAILABLE

Parameters:
{CKEDITOR.dialog.definition.button} buttonDefinition: The button definition.
{String} nextSiblingId Optional: 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:: {CKEDITOR.dialog.definition.button} The inserted button definition.

{CKEDITOR.dialog.definition.content} addContents(contentDefinition, nextSiblingId)

Since: 3.0

Adds a content definition object under this dialog definition.

NO EXAMPLE AVAILABLE

Parameters:
{CKEDITOR.dialog.definition.content} contentDefinition: The content definition.
{String} nextSiblingId Optional: 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:: {CKEDITOR.dialog.definition.content} The inserted content definition.

{CKEDITOR.dialog.definition.button} getButton(id)

Since: 3.0

Gets a button definition.

NO EXAMPLE AVAILABLE

Parameters:
{String} id: The id of the button definition.

Returns:: {CKEDITOR.dialog.definition.button} The button definition matching id.

{CKEDITOR.dialog.definition.content} getContents(id)

Since: 3.0

Gets a content definition.

NO EXAMPLE AVAILABLE

Parameters:
{String} id: The id of the content definition.

Returns:: {CKEDITOR.dialog.definition.content} The content definition matching id.

{CKEDITOR.dialog.definition.button} removeButton(id)

Since: 3.0

Removes a button definition from the dialog definition.

NO EXAMPLE AVAILABLE

Parameters:
{String} id: The id of the button definition to be removed.

Returns:: {CKEDITOR.dialog.definition.button} The removed button definition.

{CKEDITOR.dialog.definition.content} removeContents(id)

Since: 3.0

Removes a content definition from this dialog definition.

NO EXAMPLE AVAILABLE

Parameters:
{String} id: The id of the content definition to be removed.

Returns:: {CKEDITOR.dialog.definition.content} The removed content definition.

CKEditor 3 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.dialog.definitionObject