Source: util/Insets.js

  1. /*
  2.  * Copyright 2003-2006, 2009, 2017, 2020 United States Government, as represented
  3.  * by the Administrator of the National Aeronautics and Space Administration.
  4.  * All rights reserved.
  5.  *
  6.  * The NASAWorldWind/WebWorldWind platform is licensed under the Apache License,
  7.  * Version 2.0 (the "License"); you may not use this file except in compliance
  8.  * with the License. You may obtain a copy of the License
  9.  * at http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software distributed
  12.  * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  13.  * CONDITIONS OF ANY KIND, either express or implied. See the License for the
  14.  * specific language governing permissions and limitations under the License.
  15.  *
  16.  * NASAWorldWind/WebWorldWind also contains the following 3rd party Open Source
  17.  * software:
  18.  *
  19.  *    ES6-Promise – under MIT License
  20.  *    libtess.js – SGI Free Software License B
  21.  *    Proj4 – under MIT License
  22.  *    JSZip – under MIT License
  23.  *
  24.  * A complete listing of 3rd Party software notices and licenses included in
  25.  * WebWorldWind can be found in the WebWorldWind 3rd-party notices and licenses
  26.  * PDF found in code  directory.
  27.  */
  28. define(['../error/ArgumentError',
  29.         '../util/Logger'
  30.     ],
  31.     function (ArgumentError,
  32.               Logger) {
  33.         "use strict";
  35.         /**
  36.          * Constructs an Insets object that is a representation of the borders of a container.
  37.          * It specifies the space that a container must leave at each of its edges.
  38.          * @alias Insets
  39.          * @param {Number} top The inset from the top.
  40.          * @param {Number} left The inset from the left.
  41.          * @param {Number} bottom The inset from the bottom.
  42.          * @param {Number} right The inset from the right.
  43.          * @constructor
  44.          */
  45.         var Insets = function (top, left, bottom, right) {
  47.             if (arguments.length !== 4) {
  48.                 throw new ArgumentError(
  49.                     Logger.logMessage(Logger.LEVEL_SEVERE, "Insets", "constructor", "invalidArgumentCount"));
  50.             }
  52.             // These are all documented with their property accessors below.
  53.             this._top = top;
  54.             this._left = left;
  55.             this._bottom = bottom;
  56.             this._right = right;
  57.         };
  59.         /**
  60.          * Set top, left, bottom, and right to the specified values.
  61.          * @param {Number} top The inset from the top.
  62.          * @param {Number} left The inset from the left.
  63.          * @param {Number} bottom The inset from the bottom.
  64.          * @param {Number} right The inset from the right.
  65.          */
  66.         Insets.prototype.set = function (top, left, bottom, right) {
  67.             this._top = top;
  68.             this._left = left;
  69.             this._bottom = bottom;
  70.             this._right = right;
  71.         };
  73.         /**
  74.          * Creates a new copy of this insets with identical property values.
  75.          * @returns {Insets} A new insets instance with its property values the same as this one's.
  76.          */
  77.         Insets.prototype.clone = function () {
  78.             return new Insets(this._top, this._left, this._bottom, this._right);
  79.         };
  81.         /**
  82.          * Returns a string representation of this object.
  83.          * @returns {String} A string representation of this object.
  84.          */
  85.         Insets.prototype.toString = function () {
  86.             return this._top + " " + this._left + " " + this._bottom + " " + this._right;
  87.         };
  89.         Object.defineProperties(Insets.prototype, {
  91.             /**
  92.              * Indicates the the inset from the top.
  93.              * @type {Number}
  94.              * @memberof Insets.prototype
  95.              */
  96.             top: {
  97.                 get: function () {
  98.                     return this._top;
  99.                 },
  100.                 set: function (value) {
  101.                     this._top = value;
  102.                 }
  103.             },
  105.             /**
  106.              * Indicates the the inset from the left.
  107.              * @type {Number}
  108.              * @memberof Insets.prototype
  109.              */
  110.             left: {
  111.                 get: function () {
  112.                     return this._left;
  113.                 },
  114.                 set: function (value) {
  115.                     this._left = value;
  116.                 }
  117.             },
  119.             /**
  120.              * Indicates the the inset from the bottom.
  121.              * @type {Number}
  122.              * @memberof Insets.prototype
  123.              */
  124.             bottom: {
  125.                 get: function () {
  126.                     return this._bottom;
  127.                 },
  128.                 set: function (value) {
  129.                     this._bottom = value;
  130.                 }
  131.             },
  133.             /**
  134.              * Indicates the the inset from the right.
  135.              * @type {Number}
  136.              * @memberof Insets.prototype
  137.              */
  138.             right: {
  139.                 get: function () {
  140.                     return this._right;
  141.                 },
  142.                 set: function (value) {
  143.                     this._right = value;
  144.                 }
  145.             }
  147.         });
  149.         return Insets;
  150.     }
  151. );