sources/core/dom/window.js

   1 /**
   2  * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
   3  * For licensing, see LICENSE.md or http://ckeditor.com/license
   4  */
   5
   6 /**
   7  * @fileOverview Defines the {@link CKEDITOR.dom.document} class, which
   8  *              represents a DOM document.
   9  */
  10
  11 /**
  12  * Represents a DOM window.
  13  *
  14  *              var document = new CKEDITOR.dom.window( window );
  15  *
  16  * @class
  17  * @extends CKEDITOR.dom.domObject
  18  * @constructor Creates a window class instance.
  19  * @param {Object} domWindow A native DOM window.
  20  */
  21 CKEDITOR.dom.window = function( domWindow ) {
  22         CKEDITOR.dom.domObject.call( this, domWindow );
  23 };
  24
  25 CKEDITOR.dom.window.prototype = new CKEDITOR.dom.domObject();
  26
  27 CKEDITOR.tools.extend( CKEDITOR.dom.window.prototype, {
  28         /**
  29          * Moves the selection focus to this window.
  30          *
  31          *              var win = new CKEDITOR.dom.window( window );
  32          *              win.focus();
  33          */
  34         focus: function() {
  35                 this.$.focus();
  36         },
  37
  38         /**
  39          * Gets the width and height of this window's viewable area.
  40          *
  41          *              var win = new CKEDITOR.dom.window( window );
  42          *              var size = win.getViewPaneSize();
  43          *              alert( size.width );
  44          *              alert( size.height );
  45          *
  46          * @returns {Object} An object with the `width` and `height`
  47          * properties containing the size.
  48          */
  49         getViewPaneSize: function() {
  50                 var doc = this.$.document,
  51                         stdMode = doc.compatMode == 'CSS1Compat';
  52                 return {
  53                         width: ( stdMode ? doc.documentElement.clientWidth : doc.body.clientWidth ) || 0,
  54                         height: ( stdMode ? doc.documentElement.clientHeight : doc.body.clientHeight ) || 0
  55                 };
  56         },
  57
  58         /**
  59          * Gets the current position of the window's scroll.
  60          *
  61          *              var win = new CKEDITOR.dom.window( window );
  62          *              var pos = win.getScrollPosition();
  63          *              alert( pos.x );
  64          *              alert( pos.y );
  65          *
  66          * @returns {Object} An object with the `x` and `y` properties
  67          * containing the scroll position.
  68          */
  69         getScrollPosition: function() {
  70                 var $ = this.$;
  71
  72                 if ( 'pageXOffset' in $ ) {
  73                         return {
  74                                 x: $.pageXOffset || 0,
  75                                 y: $.pageYOffset || 0
  76                         };
  77                 } else {
  78                         var doc = $.document;
  79                         return {
  80                                 x: doc.documentElement.scrollLeft || doc.body.scrollLeft || 0,
  81                                 y: doc.documentElement.scrollTop || doc.body.scrollTop || 0
  82                         };
  83                 }
  84         },
  85
  86         /**
  87          * Gets the frame element containing this window context.
  88          *
  89          * @returns {CKEDITOR.dom.element} The frame element or `null` if not in a frame context.
  90          */
  91         getFrame: function() {
  92                 var iframe = this.$.frameElement;
  93                 return iframe ? new CKEDITOR.dom.element.get( iframe ) : null;
  94         }
  95 } );