add a global keyboard shortcut handler and registry to the Browser ob…

…ject
GMOD · May 1, 2012 · 571a5bf · 571a5bf
1 parent 73cdfad
commit 571a5bf
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 9 deletions.
diff --git a/js/Browser.js b/js/Browser.js
@@ -32,6 +32,7 @@ var Browser = function(params) {
     dojo.require("dijit.Dialog");
 
     this.deferredFunctions = [];
+    this.globalKeyboardShortcuts = {};
     this.isInitialized = false;
 
     this.config = params;
@@ -194,6 +195,9 @@ Browser.prototype.initView = function() {
         this.navigateTo( newRef.name );
     });
 
+    // make our global keyboard shortcut handler
+    dojo.connect( document.body, 'onkeypress', this, 'globalKeyHandler' );
+
     this.isInitialized = true;
 
     //if someone calls methods on this browser object
@@ -430,12 +434,17 @@ Browser.prototype.createTrackList = function( /**Element*/ parent ) {
     var tl_class = this.config.show_tracklist == 0 ? 'Null'                    :
                    this.config.trackListType       ? this.config.trackListType :
                                                      'Simple';
+    tl_class = JBrowse.View.TrackList[tl_class];
 
-    this.trackListView = new JBrowse.View.TrackList[tl_class]( {
+    this.trackListView = new tl_class( {
         trackConfigs: this.config.tracks,
-        renderTo: parent
+        renderTo: parent,
+        browser: this
       });
 
+    // bind the 't' key as a global keyboard shortcut
+    this.setGlobalKeyboardShortcut( 't', this.trackListView, 'toggle' );
+
     // listen for track-visibility-changing messages from views
     dojo.subscribe( '/jbrowse/v1/v/tracks/hide', this, 'onVisibleTracksChanged' );
     dojo.subscribe( '/jbrowse/v1/v/tracks/show', this, 'onVisibleTracksChanged' );
@@ -721,20 +730,41 @@ Browser.prototype.makeHelpDialog = function () {
     helplink.style.cursor = 'help';
     helplink.appendChild( document.createTextNode('Help'));
     dojo.connect(helplink, 'onclick', function() { dialog.show(); });
-    dojo.connect(document.body,  'onkeydown', function( evt ) {
+
+    this.setGlobalKeyboardShortcut( '?', dialog, 'show' );
+    dojo.connect( document.body, 'onkeydown', function(evt) {
         if( evt.keyCode != dojo.keys.SHIFT && evt.keyCode != dojo.keys.CTRL && evt.keyCode != dojo.keys.ALT )
             dialog.hide();
     });
-    dojo.connect(document.body,  'onkeypress', function( evt ) {
-        if( evt.keyChar == '?' )
-            dialog.show();
-        else if( evt.keyCode != dojo.keys.SHIFT && evt.keyCode != dojo.keys.CTRL && evt.keyCode != dojo.keys.ALT )
-            dialog.hide();
-    });
 
     return helplink;
 };
 
+/**
+ * Create a global keyboard shortcut.
+ * @param keychar the character of the key that is typed
+ * @param [...] additional arguments passed to dojo.hitch for making the handler
+ */
+Browser.prototype.setGlobalKeyboardShortcut = function( keychar ) {
+    // warn if redefining
+    if( this.globalKeyboardShortcuts[ keychar ] )
+        console.warn("WARNING: JBrowse global keyboard shortcut '"+keychar+"' redefined");
+
+    // make the wrapped handler func
+    var func = dojo.hitch.apply( dojo, Array.prototype.slice.call( arguments, 1 ) );
+
+    // remember it
+    this.globalKeyboardShortcuts[ keychar ] = func;
+};
+
+/**
+ * Key event handler that implements all global keyboard shortcuts.
+ */
+Browser.prototype.globalKeyHandler = function( evt ) {
+    var shortcut = this.globalKeyboardShortcuts[ evt.keyChar ];
+    if( shortcut )
+        shortcut.call( this );
+};
 
 Browser.prototype.makeBookmarkLink = function (area) {
     // don't make the link if we were explicitly passed a 'bookmark'

diff --git a/js/View/TrackList/Simple.js b/js/View/TrackList/Simple.js
@@ -111,6 +111,27 @@ dojo.declare( 'JBrowse.View.TrackList.Simple', null,
         dojo.forEach( trackConfigs || [], function( conf ) {
             this.trackListWidget.insertNode( conf );
         },this);
+    },
+
+    /**
+     * Make the track selector visible.
+     * This does nothing for the Simple track selector, since it is always visible.
+     */
+    show: function() {
+    },
+
+    /**
+     * Make the track selector invisible.
+     * This does nothing for the Simple track selector, since it is always visible.
+     */
+    hide: function() {
+    },
+
+    /**
+     * Toggle visibility of this track selector.
+     * This does nothing for the Simple track selector, since it is always visible.
+     */
+    toggle: function() {
     }
 
 });