Source: main/webapp/modules/Position.js

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *   http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing,
  13.  * software distributed under the License is distributed on an
  14.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15.  * KIND, either express or implied.  See the License for the
  16.  * specific language governing permissions and limitations
  17.  * under the License.
  18.  */
  20. var Guacamole = Guacamole || {};
  22. /**
  23.  * A position in 2-D space.
  24.  *
  25.  * @constructor
  26.  * @param {Guacamole.Position|object} [template={}]
  27.  *     The object whose properties should be copied within the new
  28.  *     Guacamole.Position.
  29.  */
  30. Guacamole.Position = function Position(template) {
  32.     template = template || {};
  34.     /**
  35.      * The current X position, in pixels.
  36.      *
  37.      * @type {!number}
  38.      * @default 0
  39.      */
  40.     this.x = template.x || 0;
  42.     /**
  43.      * The current Y position, in pixels.
  44.      *
  45.      * @type {!number}
  46.      * @default 0
  47.      */
  48.     this.y = template.y || 0;
  50.     /**
  51.      * Assigns the position represented by the given element and
  52.      * clientX/clientY coordinates. The clientX and clientY coordinates are
  53.      * relative to the browser viewport and are commonly available within
  54.      * JavaScript event objects. The final position is translated to
  55.      * coordinates that are relative the given element.
  56.      *
  57.      * @param {!Element} element
  58.      *     The element the coordinates should be relative to.
  59.      *
  60.      * @param {!number} clientX
  61.      *     The viewport-relative X coordinate to translate.
  62.      *
  63.      * @param {!number} clientY
  64.      *     The viewport-relative Y coordinate to translate.
  65.      */
  66.     this.fromClientPosition = function fromClientPosition(element, clientX, clientY) {
  68.         this.x = clientX - element.offsetLeft;
  69.         this.y = clientY - element.offsetTop;
  71.         // This is all JUST so we can get the position within the element
  72.         var parent = element.offsetParent;
  73.         while (parent && !(parent === document.body)) {
  74.             this.x -= parent.offsetLeft - parent.scrollLeft;
  75.             this.y -= parent.offsetTop  - parent.scrollTop;
  77.             parent = parent.offsetParent;
  78.         }
  80.         // Element ultimately depends on positioning within document body,
  81.         // take document scroll into account.
  82.         if (parent) {
  83.             var documentScrollLeft = document.body.scrollLeft || document.documentElement.scrollLeft;
  84.             var documentScrollTop = document.body.scrollTop || document.documentElement.scrollTop;
  86.             this.x -= parent.offsetLeft - documentScrollLeft;
  87.             this.y -= parent.offsetTop  - documentScrollTop;
  88.         }
  90.     };
  92. };
  94. /**
  95.  * Returns a new {@link Guacamole.Position} representing the relative position
  96.  * of the given clientX/clientY coordinates within the given element. The
  97.  * clientX and clientY coordinates are relative to the browser viewport and are
  98.  * commonly available within JavaScript event objects. The final position is
  99.  * translated to  coordinates that are relative the given element.
  100.  *
  101.  * @param {!Element} element
  102.  *     The element the coordinates should be relative to.
  103.  *
  104.  * @param {!number} clientX
  105.  *     The viewport-relative X coordinate to translate.
  106.  *
  107.  * @param {!number} clientY
  108.  *     The viewport-relative Y coordinate to translate.
  109.  *
  110.  * @returns {!Guacamole.Position}
  111.  *     A new Guacamole.Position representing the relative position of the given
  112.  *     client coordinates.
  113.  */
  114. Guacamole.Position.fromClientPosition = function fromClientPosition(element, clientX, clientY) {
  115.     var position = new Guacamole.Position();
  116.     position.fromClientPosition(element, clientX, clientY);
  117.     return position;
  118. };