Changeset 5724

Timestamp:

07/21/10 18:59:29 (3 years ago)

Author:

fredck

Message:

#6001 : Added documentation to the theme.js file.

File:

• CKEditor/trunk/_source/themes/default/theme.js (modified) (4 diffs)

CKEditor/trunk/_source/themes/default/theme.js

@@ -245 +245 @@
 })() );
 
+/**
+ * Returns the DOM element that represents a theme space. The default theme defines
+ * three spaces, namely "top", "contents" and "bottom", representing the main
+ * blocks that compose the editor interface.
+ * @param {String} spaceName The space name.
+ * @returns {CKEDITOR.dom.element} The element that represents the space.
+ * @example
+ * // Hide the bottom space in the UI.
+ * var bottom = editor.getThemeSpace( 'bottom' );
+ * bottom.setStyle( 'display', 'none' );
+ */
 CKEDITOR.editor.prototype.getThemeSpace = function( spaceName )
 {
@@ -253 +264 @@
 };
 
+/**
+ * Resizes the editor interface.
+ * @param {Number|String} width The new width. It can be an pixels integer or a
+ *              CSS size value.
+ * @param {Number|String} height The new height. It can be an pixels integer or
+ *              a CSS size value.
+ * @param {Boolean} [isContentHeight] Indicates that the provided height is to
+ *              be applied to the editor contents space, not to the entire editor
+ *              interface. Defaults to false.
+ * @param {Boolean} [resizeInner] Indicates that the first inner interface
+ *              element must receive the size, not the outer element. The default theme
+ *              defines the interface inside a pair of span elements
+ *              (<span><span>...</span></span>). By default the
+ *              first span element receives the sizes. If this parameter is set to
+ *              true, the second span is sized instead.
+ * @example
+ * editor.resize( 900, 300 );
+ * @example
+ * editor.resize( '100%', 450, true );
+ */
 CKEDITOR.editor.prototype.resize = function( width, height, isContentHeight, resizeInner )
 {
@@ -283 +314 @@
 };
 
+/**
+ * Gets the element that can be freely used to check the editor size. This method
+ * is mainly used by the resize plugin, which adds a UI handle that can be used
+ * to resize the editor.
+ * @returns {CKEDITOR.dom.element} The resizable element.
+ * @example
+ */
 CKEDITOR.editor.prototype.getResizable = function()
 {
@@ -313 +351 @@
  * };
  */
+
+/**
+ * Fired after the editor instance is resized through
+ * the {@link CKEDITOR.editor.prototype.resize} method.
+ * @name CKEDITOR#resize
+ * @event
+ */