X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=_source%2Fcore%2Feditor.js;h=b1247037feaa6c381d4b651d025fa6e2ca3575f5;hb=9afde8772159bd3436f1f5b7862960307710ae5a;hp=0b373f7b2df1bca05e628345828b07f8ddf8823f;hpb=f8fc585c18d287eb325c575596d183122486b641;p=ckeditor.git
diff --git a/_source/core/editor.js b/_source/core/editor.js
index 0b373f7..b124703 100644
--- a/_source/core/editor.js
+++ b/_source/core/editor.js
@@ -118,10 +118,46 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
'_source/' + // @Packager.RemoveLine
'skins/' + skinName + '/' ) );
+ /**
+ * The name of the skin used by this editor instance. The skin name can
+ * be set though the {@link CKEDITOR.config.skin} setting.
+ * @name CKEDITOR.editor.prototype.skinName
+ * @type String
+ * @example
+ * alert( editor.skinName ); // "kama" (e.g.)
+ */
editor.skinName = skinName;
+
+ /**
+ * The full URL of the skin directory.
+ * @name CKEDITOR.editor.prototype.skinPath
+ * @type String
+ * @example
+ * alert( editor.skinPath ); // "http://example.com/ckeditor/skins/kama/" (e.g.)
+ */
editor.skinPath = skinPath;
+
+ /**
+ * The CSS class name used for skin identification purposes.
+ * @name CKEDITOR.editor.prototype.skinClass
+ * @type String
+ * @example
+ * alert( editor.skinClass ); // "cke_skin_kama" (e.g.)
+ */
editor.skinClass = 'cke_skin_' + skinName;
+ /**
+ * The tabbing
+ * navigation order that has been calculated for this editor
+ * instance. This can be set by the {@link CKEDITOR.config.tabIndex}
+ * setting or taken from the "tabindex" attribute of the
+ * {@link #element} associated to the editor.
+ * @name CKEDITOR.editor.prototype.tabIndex
+ * @type Number
+ * @default 0 (zero)
+ * @example
+ * alert( editor.tabIndex ); // "0" (e.g.)
+ */
editor.tabIndex = editor.config.tabIndex || editor.element.getAttribute( 'tabindex' ) || 0;
// Fire the "configLoaded" event.
@@ -135,8 +171,24 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
{
CKEDITOR.lang.load( editor.config.language, editor.config.defaultLanguage, function( languageCode, lang )
{
+ /**
+ * The code for the language resources that have been loaded
+ * for the user internface elements of this editor instance.
+ * @name CKEDITOR.editor.prototype.langCode
+ * @type String
+ * @example
+ * alert( editor.langCode ); // "en" (e.g.)
+ */
editor.langCode = languageCode;
+ /**
+ * An object holding all language strings used by the editor
+ * interface.
+ * @name CKEDITOR.editor.prototype.lang
+ * @type CKEDITOR.lang
+ * @example
+ * alert( editor.lang.bold ); // "Negrito" (e.g. if language is Portuguese)
+ */
// As we'll be adding plugin specific entries that could come
// from different language code files, we need a copy of lang,
// not a direct reference to it.
@@ -175,6 +227,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
plugins = plugins.replace( removeRegex, '' );
}
+ // Load the Adobe AIR plugin conditionally.
+ CKEDITOR.env.air && ( plugins += ',adobeair' );
+
// Load all plugins defined in the "plugins" setting.
CKEDITOR.plugins.load( plugins.split( ',' ), function( plugins )
{
@@ -188,7 +243,14 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
// The list of URLs to language files.
var languageFiles = [];
- // Cache the loaded plugin names.
+ /**
+ * And object holding references to all plugins used by this
+ * editor istance.
+ * @name CKEDITOR.editor.prototype.plugins
+ * @type Object
+ * @example
+ * alert( editor.plugins.dialog.path ); // "http://example.com/ckeditor/plugins/dialog/" (e.g.)
+ */
editor.plugins = plugins;
// Loop through all plugins, to build the list of language
@@ -271,6 +333,13 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
var theme = editor.config.theme;
CKEDITOR.themes.load( theme, function()
{
+ /**
+ * The theme used by this editor instance.
+ * @name CKEDITOR.editor.prototype.theme
+ * @type CKEDITOR.theme
+ * @example
+ * alert( editor.theme ); "http://example.com/ckeditor/themes/default/" (e.g.)
+ */
var editorTheme = editor.theme = CKEDITOR.themes.get( theme );
editorTheme.path = CKEDITOR.themes.getPath( theme );
editorTheme.build( editor );
@@ -383,6 +452,13 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
throw '[CKEDITOR.editor] The instance "' + this.name + '" already exists.';
/**
+ * A unique random string assigned to each editor instance in the page.
+ * @name CKEDITOR.editor.prototype.id
+ * @type String
+ */
+ this.id = CKEDITOR.tools.getNextId();
+
+ /**
* The configurations for this editor instance. It inherits all
* settings defined in (@link CKEDITOR.config}, combined with settings
* loaded from custom configuration files and those defined inline in
@@ -596,6 +672,16 @@ CKEDITOR.tools.extend( CKEDITOR.editor.prototype,
return eventData.dataValue;
},
+ /**
+ * Gets the "raw data" currently available in the editor. This is a
+ * fast method which return the data as is, without processing, so it's
+ * not recommended to use it on resulting pages. It can be used instead
+ * combined with the {@link #loadSnapshot} so one can automatic save
+ * the editor data from time to time while the user is using the
+ * editor, to avoid data loss, without risking performance issues.
+ * @example
+ * alert( editor.getSnapshot() );
+ */
getSnapshot : function()
{
var data = this.fire( 'getSnapshot' );
@@ -610,6 +696,15 @@ CKEDITOR.tools.extend( CKEDITOR.editor.prototype,
return data;
},
+ /**
+ * Loads "raw data" in the editor. This data is loaded with processing
+ * straight to the editing area. It should not be used as a way to load
+ * any kind of data, but instead in combination with
+ * {@link #getSnapshot} produced data.
+ * @example
+ * var data = editor.getSnapshot();
+ * editor.loadSnapshot( data );
+ */
loadSnapshot : function( snapshot )
{
this.fire( 'loadSnapshot', snapshot );
@@ -664,6 +759,22 @@ CKEDITOR.tools.extend( CKEDITOR.editor.prototype,
},
/**
+ * Insert text content into the currently selected position in the
+ * editor, in WYSIWYG mode, styles of the selected element will be applied to the inserted text,
+ * spaces around the text will be leaving untouched.
+ * Note: two subsequent line-breaks will introduce one paragraph, which element depends on {@link CKEDITOR.config.enterMode};
+ * A single line-break will be instead translated into one <br />.
+ * @since 3.5
+ * @param {String} text Text to be inserted into the editor.
+ * @example
+ * CKEDITOR.instances.editor1.insertText( ' line1 \n\n line2' );
+ */
+ insertText : function( text )
+ {
+ this.fire( 'insertText', text );
+ },
+
+ /**
* Inserts an element into the currently selected position in the
* editor.
* @param {CKEDITOR.dom.element} element The element to be inserted
@@ -677,11 +788,38 @@ CKEDITOR.tools.extend( CKEDITOR.editor.prototype,
this.fire( 'insertElement', element );
},
+ /**
+ * Checks whether the current editor contents present changes when
+ * compared to the contents loaded into the editor at startup, or to
+ * the contents available in the editor when {@link #resetDirty} has
+ * been called.
+ * @returns {Boolean} "true" is the contents present changes.
+ * @example
+ * function beforeUnload( e )
+ * {
+ * if ( CKEDITOR.instances.editor1.checkDirty() )
+ * return e.returnValue = "You'll loose the changes made in the editor.";
+ * }
+ *
+ * if ( window.addEventListener )
+ * window.addEventListener( 'beforeunload', beforeUnload, false );
+ * else
+ * window.attachEvent( 'onbeforeunload', beforeUnload );
+ */
checkDirty : function()
{
return ( this.mayBeDirty && this._.previousValue !== this.getSnapshot() );
},
+ /**
+ * Resets the "dirty state" of the editor so subsequent calls to
+ * {@link #checkDirty} will return "false" if the user will not make
+ * further changes to the contents.
+ * @example
+ * alert( editor.checkDirty() ); // "true" (e.g.)
+ * editor.resetDirty();
+ * alert( editor.checkDirty() ); // "false"
+ */
resetDirty : function()
{
if ( this.mayBeDirty )
@@ -756,4 +894,50 @@ CKEDITOR.on( 'loaded', function()
* Fired when all plugins are loaded and initialized into the editor instance.
* @name CKEDITOR#pluginsLoaded
* @event
+ * @param {CKEDITOR.editor} editor The editor instance that has been destroyed.
+ */
+
+/**
+ * Fired before the command execution when {@link #execCommand} is called.
+ * @name CKEDITOR.editor#beforeCommandExec
+ * @event
+ * @param {CKEDITOR.editor} editor This editor instance.
+ * @param {String} data.name The command name.
+ * @param {Object} data.commandData The data to be sent to the command. This
+ * can be manipulated by the event listener.
+ * @param {CKEDITOR.command} data.command The command itself.
+ */
+
+/**
+ * Fired after the command execution when {@link #execCommand} is called.
+ * @name CKEDITOR.editor#afterCommandExec
+ * @event
+ * @param {CKEDITOR.editor} editor This editor instance.
+ * @param {String} data.name The command name.
+ * @param {Object} data.commandData The data sent to the command.
+ * @param {CKEDITOR.command} data.command The command itself.
+ * @param {Object} data.returnValue The value returned by the command execution.
+ */
+
+/**
+ * Fired every custom configuration file is loaded, before the final
+ * configurations initialization.
+ *
+ * Custom configuration files can be loaded thorugh the
+ * {@link CKEDITOR.config.customConfig} setting. Several files can be loading
+ * by chaning this setting.
+ * @name CKEDITOR.editor#customConfigLoaded
+ * @event
+ * @param {CKEDITOR.editor} editor This editor instance.
+ * @example
+ */
+
+/**
+ * Fired once the editor configuration is ready (loaded and processed).
+ * @name CKEDITOR.editor#configLoaded
+ * @event
+ * @param {CKEDITOR.editor} editor This editor instance.
+ * @example
+ * if( editor.config.fullPage )
+ * alert( 'This is a full page editor' );
*/