Code Index

Namespaces

Classes


Class CKFinder.dialog.definition

Class Summary
Constructor Attributes Constructor Name and Description
 
The definition of a dialog.
Field Summary
Field Attributes Field Name and Description
 
The buttons in the dialog, defined as an array of CKFinder.dialog.definition.button objects.
 
The contents in the dialog, defined as an array of CKFinder.dialog.definition.content objects.
 
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).
 
The dialog title, displayed in the dialog's header.
Class Detail
CKFinder.dialog.definition()
Since: 2.0
The definition of a dialog.
This class is not really part of the API. It just illustrates the properties that developers can use to define and create dialogs.
For a full example please check CKFinder.dialog.add
// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

// Dialog with two tabs.
CKFinder.dialog.add( 'testOnly', function( api )
      {
          var dialogDefinition = {
              title : 'Test Dialog',
              minWidth : 500,
              minHeight : 400,
              contents : [
                  {
                      id : 'tab1',
                      label : 'First Tab',
                      title : 'First Tab Title',
                      accessKey : 'F',
                      elements : [
                          {
                              type : 'text',
                              label : 'Test Text 1',
                              id : 'testText1',
                              'default' : 'hello world!'
                          }
                      ]
                  },
                  {
                      id : 'tab2',
                      label : 'Second Tab',
                      title : 'Second Tab Title',
                      accessKey : 'S',
                      elements : [
                          {
                              type : 'textarea',
                              label : 'Test Textfield',
                              id : 'testText2',
                              'default' : 'Sample text'
                          }
                      ]
                   }
              ]
          };

          return dialogDefinition;
      });
Field Detail
{Array} buttons
Since: 2.0
The buttons in the dialog, defined as an array of CKFinder.dialog.definition.button objects.
Default Value:
[ CKFinder.dialog.okButton, CKFinder.dialog.cancelButton ]

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

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

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

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

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

{Function} onOk
Since: 2.0
The function to execute when OK is pressed. To cancel closing a dialog, return false.

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

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

Copyright © 2007-2015, CKSource - Frederico Knabben. All rights reserved.