openmct/platform/commonUI/edit/src/representers/EditToolbarSelection.js

/*****************************************************************************
 * Open MCT Web, Copyright (c) 2014-2015, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT Web is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT Web includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
/*global define*/

define(
    [],
    function () {
        "use strict";

        /**
         * Tracks selection state for editable views. Selection is
         * implemented such that (from the toolbar's perspective)
         * up to two objects can be "selected" at any given time:
         *
         * * The view proxy (see the `proxy` method), which provides
         *   an interface for interacting with the view itself (e.g.
         *   for buttons like "Add")
         * * The selection, for single selected elements within the
         *   view.
         *
         * @constructor
         */
        function EditToolbarSelection() {
            var selection = [ {} ],
                selecting = false,
                selected;

            // Remove the currently-selected object
            function deselect() {
                // Nothing to do if we don't have a selected object
                if (selecting) {
                    // Clear state tracking
                    selecting = false;
                    selected = undefined;

                    // Remove the selection
                    selection.pop();

                    return true;
                }
                return false;
            }

            // Select an object
            function select(obj) {
                // Proxy is always selected
                if (obj === selection[0]) {
                    return false;
                }

                // Clear any existing selection
                deselect();

                // Note the current selection state
                selected = obj;
                selecting = true;

                // Add the selection
                selection.push(obj);
            }


            // Check if an object is selected
            function isSelected(obj) {
                return (obj === selected) || (obj === selection[0]);
            }

            // Getter for current selection
            function get() {
                return selected;
            }

            // Getter/setter for view proxy
            function proxy(p) {
                if (arguments.length > 0) {
                    selection[0] = p;
                }
                return selection[0];
            }

            // Getter for the full array of selected objects (incl. view proxy)
            function all() {
                return selection;
            }

            return {
                /**
                 * Check if an object is currently selected.
                 * @returns true if selected, otherwise false
                 */
                selected: isSelected,
                /**
                 * Select an object.
                 * @param obj the object to select
                 * @returns {boolean} true if selection changed
                 */
                select: select,
                /**
                 * Clear the current selection.
                 * @returns {boolean} true if selection changed
                 */
                deselect: deselect,
                /**
                 * Get the currently-selected object.
                 * @returns the currently selected object
                 */
                get: get,
                /**
                 * Get/set the view proxy (for toolbar actions taken upon
                 * the view itself.)
                 * @param [proxy] the view proxy (if setting)
                 * @returns the current view proxy
                 */
                proxy: proxy,
                /**
                 * Get an array containing all selections, including the
                 * selection proxy. It is generally not advisable to
                 * mutate this array directly.
                 * @returns {Array} all selections
                 */
                all: all
            };
        }

        return EditToolbarSelection;
    }
);