[Toolbar] Implement a public API for adding toolbars (#1908)

* [API] Implement a toolbar registry and a plugin to allow providing a toolbar for a selected object.
* Modify the mct-toolbar directive to get the toolbar structure from a provider based on selection.
* Implements the layout toolbar in the layout bundle

platform/forms/src/MCTToolbar.js

@@ -24,8 +24,16 @@
  * Module defining MCTForm. Created by vwoeltje on 11/10/14.
  */
 define(
-    ["./MCTForm", "text!../res/templates/toolbar.html"],
-    function (MCTForm, toolbarTemplate) {
+    [
+        "./MCTForm",
+        "text!../res/templates/toolbar.html",
+        "./controllers/ToolbarController"
+    ],
+    function (
+        MCTForm,
+        toolbarTemplate,
+        ToolbarController
+    ) {
 
         /**
          * The mct-toolbar directive allows generation of displayable
@@ -35,7 +43,7 @@ define(
          * This directive accepts three attributes:
          *
          * * `ng-model`: The model for the form; where user input
-         *   where be stored.
+         *   will be stored.
          * * `structure`: The declarative structure of the toolbar.
          *   Describes what controls should be shown and where
          *   their values should be read/written in the model.
@@ -49,9 +57,10 @@ define(
          */
         function MCTToolbar() {
             // Use Directive Definition Object from mct-form,
-            // but use the toolbar's template instead.
+            // but use the toolbar's template and controller instead.
             var ddo = new MCTForm();
             ddo.template = toolbarTemplate;
+            ddo.controller = ['$scope', 'openmct', ToolbarController];
             return ddo;
         }
 

platform/forms/src/controllers/ToolbarController.js

@@ -0,0 +1,84 @@
+define(
+    [
+        '../../../commonUI/edit/src/representers/EditToolbar'
+    ],
+    function (EditToolbar) {
+
+        // Default ng-pattern; any non whitespace
+        var NON_WHITESPACE = /\S/;
+
+        /**
+         * Controller for mct-toolbar directive.
+         *
+         * @memberof platform/forms
+         * @constructor
+         */
+        function ToolbarController($scope, openmct) {
+            var regexps = [];
+
+            // ng-pattern seems to want a RegExp, and not a
+            // string (despite what documentation says) but
+            // we want toolbar structure to be JSON-expressible,
+            // so we make RegExp's from strings as-needed
+            function getRegExp(pattern) {
+                // If undefined, don't apply a pattern
+                if (!pattern) {
+                    return NON_WHITESPACE;
+                }
+
+                // Just echo if it's already a regexp
+                if (pattern instanceof RegExp) {
+                    return pattern;
+                }
+
+                // Otherwise, assume a string
+                // Cache for easy lookup later (so we don't
+                // creat a new RegExp every digest cycle)
+                if (!regexps[pattern]) {
+                    regexps[pattern] = new RegExp(pattern);
+                }
+
+                return regexps[pattern];
+            }
+
+            this.openmct = openmct;
+            this.$scope = $scope;
+            $scope.editToolbar = {};
+            $scope.getRegExp = getRegExp;
+
+            $scope.$on("$destroy", this.destroy.bind(this));
+            openmct.selection.on('change', this.handleSelection.bind(this));
+        }
+
+        ToolbarController.prototype.handleSelection = function (selection) {
+            var domainObject = selection[0].context.oldItem;
+            var element = selection[0].context.elementProxy;
+
+            if ((domainObject && domainObject === this.selectedObject) || (element && element === this.selectedObject)) {
+                return;
+            }
+
+            this.selectedObject = domainObject || element;
+
+            if (this.editToolbar) {
+                this.editToolbar.destroy();
+            }
+
+            var structure = this.openmct.toolbars.get(selection) || [];
+            this.editToolbar = new EditToolbar(this.$scope, this.openmct, structure);
+            this.$scope.$parent.editToolbar = this.editToolbar;
+            this.$scope.$parent.editToolbar.structure = this.editToolbar.getStructure();
+            this.$scope.$parent.editToolbar.state = this.editToolbar.getState();
+
+            setTimeout(function () {
+                this.$scope.$apply();
+            }.bind(this));
+        };
+
+        ToolbarController.prototype.destroy = function () {
+            this.openmct.selection.off("change", this.handleSelection);
+        };
+
+        return ToolbarController;
+    }
+);