Code Index | File Index

Namespaces

Classes


Class CKEDITOR.dialog.definition


Defined in: plugins/dialog/dialogDefinition.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
The definition of a dialog window.
Field Summary
Field Attributes Field Name and Description
 
The buttons in the dialog, defined as an array of CKEDITOR.dialog.definition.button objects.
 
The contents in the dialog, defined as an array of CKEDITOR.dialog.definition.content objects.
 
The initial height of the dialog, in pixels.
 
The minimum height of the dialog, in pixels.
 
The minimum width of the dialog, in pixels.
 
The function to execute when Cancel is pressed.
 
The function to execute when the dialog is displayed for the first time.
 
The function to execute when OK is pressed.
 
The function to execute when the dialog is loaded (executed every time the dialog is opened).
 
How the dialog can be resized, must be one of the four contents defined below.
 
The dialog title, displayed in the dialog's header.
 
The initial width of the dialog, in pixels.
Class Detail
CKEDITOR.dialog.definition()
Since: 3.0
The definition of a dialog window.
This class is not really part of the API. It just illustrates the properties that developers can use to define and create dialogs.
// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

CKEDITOR.dialog.add( 'testOnly', function( editor )
      {
          return {
              title : 'Test Dialog',
              resizable : CKEDITOR.DIALOG_RESIZE_BOTH,
              minWidth : 500,
              minHeight : 400,
              contents : [
                  {
                      id : 'tab1',
                      label : 'First Tab',
                      title : 'First Tab Title',
                      accessKey : 'Q',
                      elements : [
                          {
                              type : 'text',
                              label : 'Test Text 1',
                              id : 'testText1',
                              'default' : 'hello world!'
                          }
                      ]
                   }
              ]
          };
      });
Field Detail
{Array} buttons
Since: 3.0
The buttons in the dialog, defined as an array of CKEDITOR.dialog.definition.button objects.
Default Value:
[ CKEDITOR.dialog.okButton, CKEDITOR.dialog.cancelButton ]

{Array} contents
Since: 3.0
The contents in the dialog, defined as an array of CKEDITOR.dialog.definition.content objects. Required.

{Number} height
Since: 3.5.3
The initial height of the dialog, in pixels.
Default Value:
@CKEDITOR.dialog.definition.prototype.minHeight

{Number} minHeight
Since: 3.0
The minimum height of the dialog, in pixels.
Default Value:
400

{Number} minWidth
Since: 3.0
The minimum width of the dialog, in pixels.
Default Value:
600

{Function} onCancel
Since: 3.0
The function to execute when Cancel is pressed.

{Function} onLoad
Since: 3.0
The function to execute when the dialog is displayed for the first time.

{Function} onOk
Since: 3.0
The function to execute when OK is pressed.

{Function} onShow
Since: 3.0
The function to execute when the dialog is loaded (executed every time the dialog is opened).

{Number} resizable
Since: 3.0
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
Default Value:
CKEDITOR.DIALOG_RESIZE_NONE

{String} title
Since: 3.0
The dialog title, displayed in the dialog's header. Required.

{Number} width
Since: 3.5.3
The initial width of the dialog, in pixels.
Default Value:
@CKEDITOR.dialog.definition.prototype.minWidth

Copyright © 2003-2010, CKSource - Frederico Knabben. All rights reserved.