      1 ﻿/*
      2 Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
      3 For licensing, see LICENSE.html or http://ckeditor.com/license
      4 */
      5
      6 /**
      7  * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which
      8  *		contains the defintion of a plugin. This file is for documentation
      9  *		purposes only.
     10  */
     11
     12 /**
     13  * (Virtual Class) Do not call this constructor. This class is not really part
     14  *		of the API. It just illustrates the features of plugin objects to be
     15  *		passed to the {@link CKEDITOR.plugins.add} function.
     16  * @name CKEDITOR.pluginDefinition
     17  * @constructor
     18  * @example
     19  */
     20
     21 /**
     22  * A list of plugins that are required by this plugin. Note that this property
     23  * doesn't guarantee the loading order of the plugins.
     24  * @name CKEDITOR.pluginDefinition.prototype.requires
     25  * @type Array
     26  * @example
     27  * CKEDITOR.plugins.add( 'sample',
     28  * {
     29  *     requires : [ 'button', 'selection' ]
     30  * });
     31  */
     32
     33  /**
     34  * Function called on initialization of every editor instance created in the
     35  * page before the init() call task. The beforeInit function will be called for
     36  * all plugins, after that the init function is called for all of them. This
     37  * feature makes it possible to initialize things that could be used in the
     38  * init function of other plugins.
     39  * @name CKEDITOR.pluginDefinition.prototype.beforeInit
     40  * @function
     41  * @param {CKEDITOR.editor} editor The editor instance being initialized.
     42  * @example
     43  * CKEDITOR.plugins.add( 'sample',
     44  * {
     45  *     beforeInit : function( editor )
     46  *     {
     47  *         alert( 'Editor "' + editor.name + '" is to be initialized!' );
     48  *     }
     49  * });
     50  */
     51
     52  /**
     53  * Function called on initialization of every editor instance created in the
     54  * page.
     55  * @name CKEDITOR.pluginDefinition.prototype.init
     56  * @function
     57  * @param {CKEDITOR.editor} editor The editor instance being initialized.
     58  * @example
     59  * CKEDITOR.plugins.add( 'sample',
     60  * {
     61  *     init : function( editor )
     62  *     {
     63  *         alert( 'Editor "' + editor.name + '" is being initialized!' );
     64  *     }
     65  * });
     66  */
     67