From 4be2a3f1cdb7e6ba1e2be19e66df7d0ea1a7ece6 Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Wed, 18 Feb 2015 08:55:58 -0800
Subject: [PATCH] [Fixed Position] Add selection manager

Add utility class so that layouts/fixed position views
can track their current selection state more simply.
WTD-879.
---
 .../features/layout/src/LayoutSelection.js    | 110 ++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 platform/features/layout/src/LayoutSelection.js

diff --git a/platform/features/layout/src/LayoutSelection.js b/platform/features/layout/src/LayoutSelection.js
new file mode 100644
index 0000000000..747694d50b
--- /dev/null
+++ b/platform/features/layout/src/LayoutSelection.js
@@ -0,0 +1,110 @@
+/*global define*/
+
+define(
+    [],
+    function () {
+        "use strict";
+
+        /**
+         * Tracks selection state for Layout and Fixed Position views.
+         * @param {Array} selection the selection array from the view's scope
+         * @param [proxy] an object which represents the selection of the view
+         *        itself (which handles view-level toolbar behavior)
+         */
+        function LayoutSelection(selection, proxy) {
+            var selecting = false,
+                selected;
+
+            // Find the proxy in the array; our selected objects will be
+            // positioned next to that
+            function proxyIndex() {
+                return selection.indexOf(proxy);
+            }
+
+            // 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.splice(proxyIndex() + 1, 1);
+
+                    return true;
+                }
+                return false;
+            }
+
+            // Select an object
+            function select(obj) {
+                // We want this selection to end up near the proxy
+                var index = proxyIndex() + 1;
+
+                // Proxy is always selected
+                if (obj === proxy) {
+                    return false;
+                }
+
+                // Clear any existing selection
+                deselect();
+
+                // Note the current selection state
+                selected = obj;
+                selecting = true;
+
+                // Are we at the end of the array?
+                if (selection.length === index) {
+                    // Add it to the end
+                    selection.push(obj);
+                } else {
+                    // Splice it into the array
+                    selection.splice(index, 0, obj);
+                }
+            }
+
+            // Remove any selected object, and the proxy itself
+            function destroy() {
+                deselect();
+                selection.splice(proxyIndex(), 1);
+            }
+
+            // Check if an object is selected
+            function isSelected(obj) {
+                return (obj === selected) || (obj === proxy);
+            }
+
+            // Start with the proxy selected
+            selection.push(proxy);
+
+            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,
+                /**
+                 * Clear the selection, including the proxy, and dispose
+                 * of this selection scope. No other calls to methods on
+                 * this object are expected after `destroy` has been
+                 * called; their behavior will be undefined.
+                 */
+                destroy: destroy
+            };
+        }
+
+        return LayoutSelection;
+    }
+);
\ No newline at end of file