GUI -- [ONOS-265] - fixed quick help:

- 'keymap' renamed 'quickhelp'
- opacity of text now solid.
- translucent background now auto-fits the content.
- renamed files.

Change-Id: I217f9e26acb0beb2686d1935e1e986f1404980db

@@ -40,7 +40,7 @@
     <link rel="stylesheet" href="mast2.css">
     <link rel="stylesheet" href="mast2.css">
     <link rel="stylesheet" href="floatPanel.css">
     <link rel="stylesheet" href="floatPanel.css">
     <link rel="stylesheet" href="feedback.css">
     <link rel="stylesheet" href="feedback.css">
-    <link rel="stylesheet" href="keymap.css">
+    <link rel="stylesheet" href="onosQuickHelp.css">
 
 
     <!-- This is where contributed stylesheets get INJECTED -->
     <!-- This is where contributed stylesheets get INJECTED -->
     <!-- TODO: replace with template marker and inject refs server-side -->
     <!-- TODO: replace with template marker and inject refs server-side -->
@@ -70,10 +70,10 @@
             <!-- NOTE: alert content injected here, as needed -->
             <!-- NOTE: alert content injected here, as needed -->
         </div>
         </div>
         <div id="feedback">
         <div id="feedback">
-            <!-- NOTE: feedback to user -->
+            <!-- NOTE: feedback flashes to user -->
         </div>
         </div>
-        <div id="keymap">
-            <!-- NOTE: key bindings map -->
+        <div id="quickhelp">
+            <!-- NOTE: key bindings and mouse gesture help -->
         </div>
         </div>
     </div>
     </div>
 
 
@@ -93,7 +93,7 @@
     <!-- Framework module files included here -->
     <!-- Framework module files included here -->
     <script src="mast2.js"></script>
     <script src="mast2.js"></script>
     <script src="feedback.js"></script>
     <script src="feedback.js"></script>
-    <script src="keymap.js"></script>
+    <script src="onosQuickHelp.js"></script>
 
 
     <!-- View Module Templates; REMOVE THESE LINES, FOR PRODUCTION -->
     <!-- View Module Templates; REMOVE THESE LINES, FOR PRODUCTION -->
     <script src="module-svg-template.js"></script>
     <script src="module-svg-template.js"></script>

@@ -415,7 +415,7 @@
 
 
         function setupGlobalKeys() {
         function setupGlobalKeys() {
             keyHandler.globalKeys = {
             keyHandler.globalKeys = {
-                slash: [keyMap, 'Show / hide keyboard shortcuts'],
+                slash: [quickHelp, 'Show / hide Quick Help'],
                 esc: [escapeKey, 'Dismiss dialog or cancel selections'],
                 esc: [escapeKey, 'Dismiss dialog or cancel selections'],
                 T: [toggleTheme, "Toggle theme"]
                 T: [toggleTheme, "Toggle theme"]
             };
             };
@@ -427,19 +427,19 @@
             };
             };
         }
         }
 
 
-        function keyMap(view, key, code, ev) {
-            libApi.keymap.show(keyHandler);
+        function quickHelp(view, key, code, ev) {
+            libApi.quickHelp.show(keyHandler);
             return true;
             return true;
         }
         }
 
 
         function escapeKey(view, key, code, ev) {
         function escapeKey(view, key, code, ev) {
-            if (libApi.keymap.hide()) {
-                return true;
-            }
             if (alerts.open) {
             if (alerts.open) {
                 closeAlerts();
                 closeAlerts();
                 return true;
                 return true;
             }
             }
+            if (libApi.quickHelp.hide()) {
+                return true;
+            }
             return false;
             return false;
         }
         }
 
 

@@ -15,53 +15,54 @@
  */
  */
 
 
 /*
 /*
- ONOS GUI -- Key map layer -- CSS file
+ ONOS GUI -- Quick Help layer -- CSS file
 
 
  @author Simon Hunt
  @author Simon Hunt
  */
  */
 
 
-#keymap {
+#quickhelp {
     z-index: 1300;
     z-index: 1300;
 }
 }
 
 
-#keymap svg {
+#quickhelp svg {
     position: absolute;
     position: absolute;
     bottom: 40px;
     bottom: 40px;
-    opacity: 0.7;
+    opacity: 1;
 }
 }
 
 
-#keymap svg g.pane {
+#quickhelp svg g.help rect {
     fill: black;
     fill: black;
+    opacity: 0.7;
 }
 }
 
 
-#keymap svg text.title {
+#quickhelp svg text.title {
     font-size: 10pt;
     font-size: 10pt;
     font-style: italic;
     font-style: italic;
     text-anchor: middle;
     text-anchor: middle;
     fill: #999;
     fill: #999;
 }
 }
 
 
-#keymap svg g.keyItem {
+#quickhelp svg g.keyItem {
     fill: white;
     fill: white;
 }
 }
 
 
-#keymap svg g.keyItem line {
-    stroke: #444;
-    stroke-dasharray: 4 4;
+#quickhelp svg g.keyItem line {
+    stroke: #888;
+    stroke-dasharray: 2 2;
 }
 }
 
 
-#keymap svg text {
+#quickhelp svg text {
     font-size: 7pt;
     font-size: 7pt;
     alignment-baseline: middle;
     alignment-baseline: middle;
 }
 }
 
 
-#keymap svg text.key {
+#quickhelp svg text.key {
     font-size: 7pt;
     font-size: 7pt;
     fill: #add;
     fill: #add;
 }
 }
 
 
-#keymap svg text.desc {
+#quickhelp svg text.desc {
     font-size: 7pt;
     font-size: 7pt;
-    fill: #aaa;
+    fill: #ddd;
 }
 }
 
 

@@ -15,7 +15,7 @@
  */
  */
 
 
 /*
 /*
- ONOS GUI -- Keymap Layer
+ ONOS GUI -- Quick Help Layer
 
 
  Defines the key-map layer for the UI. Used to give user a list of
  Defines the key-map layer for the UI. Used to give user a list of
  key bindings; both global, and for the current view.
  key bindings; both global, and for the current view.
@@ -33,34 +33,54 @@
     var w = '100%',
     var w = '100%',
         h = '80%',
         h = '80%',
         fade = 500,
         fade = 500,
-        vb = '-220 -220 440 440',
-        paneW = 400,
-        paneH = 280,
-        offy = 65,
-        dy = 14,
-        offKey = 40,
-        offDesc = offKey + 50,
-        lineW = paneW - (2*offKey);
+        vb = '-200 0 400 400';
 
 
     // State variables
     // State variables
     var data = [];
     var data = [];
 
 
     // DOM elements and the like
     // DOM elements and the like
-    var kmdiv = d3.select('#keymap');
+    var qhdiv = d3.select('#quickhelp'),
+        svg = qhdiv.select('svg'),
+        pane,
+        rect,
+        items;
 
 
+    // General functions
     function isA(a) {
     function isA(a) {
         return $.isArray(a) ? a : null;
         return $.isArray(a) ? a : null;
     }
     }
 
 
+    var keyDisp = {
+        equals: '=',
+        dash: '-',
+        slash: '/',
+        leftArrow: 'L-arrow',
+        upArrow: 'U-arrow',
+        rightArrow: 'R-arrow',
+        downArrow: 'D-arrow'
+    };
+
+    function cap(s) {
+        return s.replace(/^[a-z]/, function (m) { return m.toUpperCase(); });
+    }
+
+    function mkKeyDisp(id) {
+        var v = keyDisp[id] || id;
+        return cap(v);
+    }
 
 
-    var svg = kmdiv.select('svg'),
-        pane;
+    // layout configuration
+    var pad = 8,
+        offy = 45,
+        dy = 14,
+        offDesc = 40;
 
 
+    // D3 magic
     function updateKeyItems() {
     function updateKeyItems() {
-        var items = pane.selectAll('.keyItem')
+        var keyItems = items.selectAll('.keyItem')
             .data(data);
             .data(data);
 
 
-        var entering = items.enter()
+        var entering = keyItems.enter()
             .append('g')
             .append('g')
             .attr({
             .attr({
                 id: function (d) { return d.id; },
                 id: function (d) { return d.id; },
@@ -73,19 +93,13 @@
 
 
             if (d.id === '_') {
             if (d.id === '_') {
                 el.append('line')
                 el.append('line')
-                    .attr({
-                        class: 'sep',
-                        x1: offKey,
-                        y1: y,
-                        x2: offKey + lineW,
-                        y2: y
-                    });
+                    .attr({ x1: 0, y1: y, x2: 1, y2: y});
             } else {
             } else {
                 el.append('text')
                 el.append('text')
                     .text(d.key)
                     .text(d.key)
                     .attr({
                     .attr({
                         class: 'key',
                         class: 'key',
-                        x: offKey,
+                        x: 0,
                         y: y
                         y: y
                     });
                     });
 
 
@@ -98,6 +112,22 @@
                     });
                     });
             }
             }
         });
         });
+
+        var box = items.node().getBBox(),
+            paneW = box.width + pad * 2,
+            paneH = box.height + offy;
+
+        items.select('line').attr('x2', box.width);
+        items.attr('transform', translate(-paneW/2, -pad));
+        rect.attr({
+            width: paneW,
+            height: paneH,
+            transform: translate(-paneW/2-pad, 0)
+        });
+    }
+
+    function translate(x, y) {
+        return 'translate(' + x + ',' + y + ')';
     }
     }
 
 
     function aggregateData(bindings) {
     function aggregateData(bindings) {
@@ -127,7 +157,7 @@
                     {
                     {
                         id: id,
                         id: id,
                         type: type,
                         type: type,
-                        key: k,
+                        key: mkKeyDisp(k),
                         desc: desc
                         desc: desc
                     }
                     }
                 );
                 );
@@ -138,51 +168,47 @@
                 });
                 });
             }
             }
         }
         }
-
     }
     }
 
 
-    function populateBindings(bindings) {
-        svg.append('g')
+    function popBind(bindings) {
+        pane = svg.append('g')
             .attr({
             .attr({
-                class: 'keyBindings',
-                transform: 'translate(-200,-200)',
+                class: 'help',
                 opacity: 0
                 opacity: 0
-            })
-            .transition()
-            .duration(fade)
-            .attr('opacity', 1);
-
-        pane = svg.select('g');
-
-        pane.append('rect')
-            .attr({
-                width: paneW,
-                height: paneH,
-                rx: 8
             });
             });
 
 
+        rect = pane.append('rect')
+            .attr('rx', 8);
+
         pane.append('text')
         pane.append('text')
-            .text('Keyboard Shortcuts')
+            .text('Quick Help')
             .attr({
             .attr({
-                x: 200,
-                y: 0,
-                dy: '1.4em',
-                class: 'title'
+                class: 'title',
+                dy: '1.2em',
+                transform: translate(-pad,0)
             });
             });
 
 
+        items = pane.append('g');
+
         aggregateData(bindings);
         aggregateData(bindings);
         updateKeyItems();
         updateKeyItems();
+
+        _fade(1);
     }
     }
 
 
     function fadeBindings() {
     function fadeBindings() {
-        svg.selectAll('g.keyBindings')
+        _fade(0);
+    }
+
+    function _fade(o) {
+        svg.selectAll('g.help')
             .transition()
             .transition()
             .duration(fade)
             .duration(fade)
-            .attr('opacity', 0);
+            .attr('opacity', o);
     }
     }
 
 
     function addSvg() {
     function addSvg() {
-        svg = kmdiv.append('svg')
+        svg = qhdiv.append('svg')
             .attr({
             .attr({
                 width: w,
                 width: w,
                 height: h,
                 height: h,
@@ -196,18 +222,18 @@
             .remove();
             .remove();
     }
     }
 
 
-    function showKeyMap(bindings) {
-        svg = kmdiv.select('svg');
+    function showQuickHelp(bindings) {
+        svg = qhdiv.select('svg');
         if (svg.empty()) {
         if (svg.empty()) {
             addSvg();
             addSvg();
-            populateBindings(bindings);
+            popBind(bindings);
         } else {
         } else {
-            hideKeyMap();
+            hideQuickHelp();
         }
         }
     }
     }
 
 
-    function hideKeyMap() {
-        svg = kmdiv.select('svg');
+    function hideQuickHelp() {
+        svg = qhdiv.select('svg');
         if (!svg.empty()) {
         if (!svg.empty()) {
             fadeBindings();
             fadeBindings();
             removeSvg();
             removeSvg();
@@ -216,8 +242,8 @@
         return false;
         return false;
     }
     }
 
 
-    onos.ui.addLib('keymap', {
-        show: showKeyMap,
-        hide: hideKeyMap
+    onos.ui.addLib('quickHelp', {
+        show: showQuickHelp,
+        hide: hideQuickHelp
     });
     });
 }(ONOS));
 }(ONOS));