Changeset 5724


Ignore:
Timestamp:
07/21/2010 06:59:29 PM (5 years ago)
Author:
fredck
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_source/themes/default/theme.js

    r5681 r5724  
    245245})() );
    246246
     247/**
     248 * Returns the DOM element that represents a theme space. The default theme defines
     249 * three spaces, namely "top", "contents" and "bottom", representing the main
     250 * blocks that compose the editor interface.
     251 * @param {String} spaceName The space name.
     252 * @returns {CKEDITOR.dom.element} The element that represents the space.
     253 * @example
     254 * // Hide the bottom space in the UI.
     255 * var bottom = editor.getThemeSpace( 'bottom' );
     256 * bottom.setStyle( 'display', 'none' );
     257 */
    247258CKEDITOR.editor.prototype.getThemeSpace = function( spaceName )
    248259{
     
    253264};
    254265
     266/**
     267 * Resizes the editor interface.
     268 * @param {Number|String} width The new width. It can be an pixels integer or a
     269 *              CSS size value.
     270 * @param {Number|String} height The new height. It can be an pixels integer or
     271 *              a CSS size value.
     272 * @param {Boolean} [isContentHeight] Indicates that the provided height is to
     273 *              be applied to the editor contents space, not to the entire editor
     274 *              interface. Defaults to false.
     275 * @param {Boolean} [resizeInner] Indicates that the first inner interface
     276 *              element must receive the size, not the outer element. The default theme
     277 *              defines the interface inside a pair of span elements
     278 *              (<span><span>...</span></span>). By default the
     279 *              first span element receives the sizes. If this parameter is set to
     280 *              true, the second span is sized instead.
     281 * @example
     282 * editor.resize( 900, 300 );
     283 * @example
     284 * editor.resize( '100%', 450, true );
     285 */
    255286CKEDITOR.editor.prototype.resize = function( width, height, isContentHeight, resizeInner )
    256287{
     
    283314};
    284315
     316/**
     317 * Gets the element that can be freely used to check the editor size. This method
     318 * is mainly used by the resize plugin, which adds a UI handle that can be used
     319 * to resize the editor.
     320 * @returns {CKEDITOR.dom.element} The resizable element.
     321 * @example
     322 */
    285323CKEDITOR.editor.prototype.getResizable = function()
    286324{
     
    313351 * };
    314352 */
     353
     354/**
     355 * Fired after the editor instance is resized through
     356 * the {@link CKEDITOR.editor.prototype.resize} method.
     357 * @name CKEDITOR#resize
     358 * @event
     359 */
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy