dijit/layout/StackController.js

  • Provides:

    • dijit.layout.StackController
  • dijit.layout.StackController

    • type
      Function
    • chains:
      • dijit._Widget: (prototype)
      • dijit._Widget: (call)
      • dijit._Templated: (call)
      • dijit._Container: (call)
    • mixins:
      • dijit._Templated.prototype: (prototype)
      • dijit._Container.prototype: (prototype)
    • summary
      Set of buttons to select a page in a page list.
    • description
      Monitors the specified StackContainer, and whenever a page is
      added, deleted, or selected, updates itself accordingly.
    • source: [view]
          this.pane2button = {};  // mapping from pane id to buttons
          this.pane2connects = {}; // mapping from pane id to this.connect() handles
          this.pane2watches = {};  // mapping from pane id to watch() handles
  • dijit.layout.StackController.templateString

    • summary
  • dijit.layout.StackController.containerId

    • tags: const
    • type
      String
    • summary
      The id of the page container that I point to
  • dijit.layout.StackController.buttonWidget

    • tags: const
    • type
      String
    • summary
      The name of the button widget to create to correspond to each page
  • dijit.layout.StackController.buildRendering

    • type
      Function
    • source: [view]
          this.inherited(arguments);
          dijit.setWaiRole(this.domNode, "tablist"); // TODO: unneeded? it's in template above.
    • summary
  • dijit.layout.StackController.postCreate

    • type
      Function
    • source: [view]
          this.inherited(arguments);


          // Listen to notifications from StackContainer
          this.subscribe(this.containerId+"-startup", "onStartup");
          this.subscribe(this.containerId+"-addChild", "onAddChild");
          this.subscribe(this.containerId+"-removeChild", "onRemoveChild");
          this.subscribe(this.containerId+"-selectChild", "onSelectChild");
          this.subscribe(this.containerId+"-containerKeyPress", "onContainerKeyPress");
    • summary
  • dijit.layout.StackController.onStartup

    • type
      Function
    • parameters:
      • info: (typeof Object)
    • source: [view]
          dojo.forEach(info.children, this.onAddChild, this);
          if(info.selected){
           // Show button corresponding to selected pane (unless selected
           // is null because there are no panes)
           this.onSelectChild(info.selected);
          }
    • summary
      Called after StackContainer has finished initializing
    • tags:
  • dijit.layout.StackController.destroy

    • type
      Function
    • source: [view]
          for(var pane in this.pane2button){
           this.onRemoveChild(dijit.byId(pane));
          }
          this.inherited(arguments);
    • summary
  • dijit.layout.StackController.onAddChild

    • type
      Function
    • parameters:
      • page: (typeof dijit._Widget)
      • insertIndex: (typeof Integer)
    • source: [view]
      define("dijit/layout/StackController", ["dojo", "dijit", "dijit/_Widget", "dijit/_Templated", "dijit/_Container", "dijit/form/ToggleButton", "i18n!dijit/nls/common"], function(dojo, dijit) {


      dojo.declare(
        "dijit.layout.StackController",
        [dijit._Widget, dijit._Templated, dijit._Container],
        {
         // summary:
         //  Set of buttons to select a page in a page list.
         // description:
         //  Monitors the specified StackContainer, and whenever a page is
         //  added, deleted, or selected, updates itself accordingly.


         templateString: "",


         // containerId: [const] String
         //  The id of the page container that I point to
         containerId: "",


         // buttonWidget: [const] String
         //  The name of the button widget to create to correspond to each page
         buttonWidget: "dijit.layout._StackButton",


         constructor: function(){
          this.pane2button = {};  // mapping from pane id to buttons
          this.pane2connects = {}; // mapping from pane id to this.connect() handles
          this.pane2watches = {};  // mapping from pane id to watch() handles
         },


         buildRendering: function(){
          this.inherited(arguments);
          dijit.setWaiRole(this.domNode, "tablist"); // TODO: unneeded? it's in template above.
         },


         postCreate: function(){
          this.inherited(arguments);


          // Listen to notifications from StackContainer
          this.subscribe(this.containerId+"-startup", "onStartup");
          this.subscribe(this.containerId+"-addChild", "onAddChild");
          this.subscribe(this.containerId+"-removeChild", "onRemoveChild");
          this.subscribe(this.containerId+"-selectChild", "onSelectChild");
          this.subscribe(this.containerId+"-containerKeyPress", "onContainerKeyPress");
         },


         onStartup: function(/*Object*/ info){
          // summary:
          //  Called after StackContainer has finished initializing
          // tags:
          //  private
          dojo.forEach(info.children, this.onAddChild, this);
          if(info.selected){
           // Show button corresponding to selected pane (unless selected
           // is null because there are no panes)
           this.onSelectChild(info.selected);
          }
         },


         destroy: function(){
          for(var pane in this.pane2button){
           this.onRemoveChild(dijit.byId(pane));
          }
          this.inherited(arguments);
         },


         onAddChild: function(/*dijit._Widget*/ page, /*Integer?*/ insertIndex){
          // summary:
          //  Called whenever a page is added to the container.
          //  Create button corresponding to the page.
          // tags:
          //  private


          // create an instance of the button widget
          var cls = dojo.getObject(this.buttonWidget);
          var button = new cls({
           id: this.id + "_" + page.id,
           label: page.title,
           dir: page.dir,
           lang: page.lang,
           showLabel: page.showTitle,
           iconClass: page.iconClass,
           closeButton: page.closable,
           title: page.tooltip
          });
          dijit.setWaiState(button.focusNode,"selected", "false");




          // map from page attribute to corresponding tab button attribute
          var pageAttrList = ["title", "showTitle", "iconClass", "closable", "tooltip"],
           buttonAttrList = ["label", "showLabel", "iconClass", "closeButton", "title"];


          // watch() so events like page title changes are reflected in tab button
          this.pane2watches[page.id] = dojo.map(pageAttrList, function(pageAttr, idx){
           return page.watch(pageAttr, function(name, oldVal, newVal){
            button.set(buttonAttrList[idx], newVal);
           });
          });

           
          // connections so that clicking a tab button selects the corresponding page
          this.pane2connects[page.id] = [
           this.connect(button, 'onClick', dojo.hitch(this,"onButtonClick", page)),
           this.connect(button, 'onClickCloseButton', dojo.hitch(this,"onCloseButtonClick", page))
          ];


          this.addChild(button, insertIndex);
          this.pane2button[page.id] = button;
          page.controlButton = button; // this value might be overwritten if two tabs point to same container
          if(!this._currentChild){ // put the first child into the tab order
           button.focusNode.setAttribute("tabIndex", "0");
           dijit.setWaiState(button.focusNode, "selected", "true");
           this._currentChild = page;
          }
          // make sure all tabs have the same length
          if(!this.isLeftToRight() && dojo.isIE && this._rectifyRtlTabList){
           this._rectifyRtlTabList();
          }
    • summary
      Called whenever a page is added to the container.
      Create button corresponding to the page.
  • dijit.layout.StackController.onRemoveChild

    • type
      Function
    • parameters:
      • page: (typeof dijit._Widget)
    • source: [view]
          if(this._currentChild === page){ this._currentChild = null; }


          // disconnect/unwatch connections/watches related to page being removed
          dojo.forEach(this.pane2connects[page.id], dojo.hitch(this, "disconnect"));
          delete this.pane2connects[page.id];
          dojo.forEach(this.pane2watches[page.id], function(w){ w.unwatch(); });
          delete this.pane2watches[page.id];


          var button = this.pane2button[page.id];
          if(button){
           this.removeChild(button);
           delete this.pane2button[page.id];
           button.destroy();
          }
          delete page.controlButton;
    • summary
      Called whenever a page is removed from the container.
      Remove the button corresponding to the page.
    • tags:
  • dijit.layout.StackController.onSelectChild

    • type
      Function
    • parameters:
      • page: (typeof dijit._Widget)
    • source: [view]
          if(!page){ return; }


          if(this._currentChild){
           var oldButton=this.pane2button[this._currentChild.id];
           oldButton.set('checked', false);
           dijit.setWaiState(oldButton.focusNode, "selected", "false");
           oldButton.focusNode.setAttribute("tabIndex", "-1");
          }


          var newButton=this.pane2button[page.id];
          newButton.set('checked', true);
          dijit.setWaiState(newButton.focusNode, "selected", "true");
          this._currentChild = page;
          newButton.focusNode.setAttribute("tabIndex", "0");
          var container = dijit.byId(this.containerId);
          dijit.setWaiState(container.containerNode, "labelledby", newButton.id);
    • summary
      Called when a page has been selected in the StackContainer, either by me or by another StackController
    • tags:
  • dijit.layout.StackController.onButtonClick

    • type
      Function
    • parameters:
      • page: (typeof dijit._Widget)
    • source: [view]
          var container = dijit.byId(this.containerId);
          container.selectChild(page);
    • summary
      Called whenever one of my child buttons is pressed in an attempt to select a page
    • tags:
  • dijit.layout.StackController.onCloseButtonClick

    • type
      Function
    • parameters:
      • page: (typeof dijit._Widget)
    • source: [view]
          var container = dijit.byId(this.containerId);
          container.closeChild(page);
          if(this._currentChild){
           var b = this.pane2button[this._currentChild.id];
           if(b){
            dijit.focus(b.focusNode || b.domNode);
           }
          }
    • summary
      Called whenever one of my child buttons [X] is pressed in an attempt to close a page
    • tags:
  • dijit.layout.StackController.adjacent

    • type
      Function
    • parameters:
      • forward: (typeof Boolean)
    • source: [view]
          if(!this.isLeftToRight() && (!this.tabPosition || /top|bottom/.test(this.tabPosition))){ forward = !forward; }
          // find currently focused button in children array
          var children = this.getChildren();
          var current = dojo.indexOf(children, this.pane2button[this._currentChild.id]);
          // pick next button to focus on
          var offset = forward ? 1 : children.length - 1;
          return children[ (current + offset) % children.length ]; // dijit._Widget
    • summary
      Helper for onkeypress to find next/previous button
    • tags:
    • returns
      dijit._Widget
  • dijit.layout.StackController.onkeypress

    • type
      Function
    • parameters:
      • e: (typeof Event)
    • source: [view]
          if(this.disabled || e.altKey ){ return; }
          var forward = null;
          if(e.ctrlKey || !e._djpage){
           var k = dojo.keys;
           switch(e.charOrCode){
            case k.LEFT_ARROW:
            case k.UP_ARROW:
             if(!e._djpage){ forward = false; }
             break;
            case k.PAGE_UP:
             if(e.ctrlKey){ forward = false; }
             break;
            case k.RIGHT_ARROW:
            case k.DOWN_ARROW:
             if(!e._djpage){ forward = true; }
             break;
            case k.PAGE_DOWN:
             if(e.ctrlKey){ forward = true; }
             break;
            case k.HOME:
            case k.END:
             var children = this.getChildren();
             if(children && children.length){
              children[e.charOrCode == k.HOME ? 0 : children.length-1].onClick();
             }
             dojo.stopEvent(e);
             break;
            case k.DELETE:
             if(this._currentChild.closable){
              this.onCloseButtonClick(this._currentChild);
             }
             dojo.stopEvent(e);
             break;
            default:
             if(e.ctrlKey){
              if(e.charOrCode === k.TAB){
               this.adjacent(!e.shiftKey).onClick();
               dojo.stopEvent(e);
              }else if(e.charOrCode == "w"){
               if(this._currentChild.closable){
                this.onCloseButtonClick(this._currentChild);
               }
               dojo.stopEvent(e); // avoid browser tab closing.
              }
             }
           }
           // handle next/previous page navigation (left/right arrow, etc.)
           if(forward !== null){
            this.adjacent(forward).onClick();
            dojo.stopEvent(e);
           }
          }
    • summary
      Handle keystrokes on the page list, for advancing to next/previous button
      and closing the current page if the page is closable.
    • tags:
  • dijit.layout.StackController.onContainerKeyPress

    • type
      Function
    • parameters:
      • info: (typeof Object)
    • source: [view]
          info.e._djpage = info.page;
          this.onkeypress(info.e);
    • summary
      Called when there was a keypress on the container
    • tags:
  • dijit.layout.StackController._currentChild

    • summary
  • dijit.layout.StackController.pane2button

    • summary
  • dijit.layout.StackController.pane2connects

    • summary
  • dijit.layout.StackController.pane2watches

    • summary
  • dijit.layout._StackButton

    • type
      Function
    • chains:
      • dijit.form.ToggleButton: (prototype)
      • dijit.form.ToggleButton: (call)
    • summary
      Internal widget used by StackContainer.
  • dijit.layout._StackButton.tabIndex

    • summary
  • dijit.layout._StackButton.buildRendering

    • type
      Function
    • parameters:
      • evt: (typeof Event)
    • source: [view]
         this.inherited(arguments);
         dijit.setWaiRole((this.focusNode || this.domNode), "tab");
    • summary
  • dijit.layout._StackButton.onClick

    • type
      Function
    • parameters:
      • evt: (typeof Event)
    • source: [view]
         dijit.focus(this.focusNode);


         // ... now let StackController catch the event and tell me what to do
    • summary
      This is for TabContainer where the tabs are <span> rather than button,
      so need to set focus explicitly (on some browsers)
      Note that you shouldn't override this method, but you can connect to it.
  • dijit.layout._StackButton.onClickCloseButton

    • type
      Function
    • parameters:
      • evt: (typeof Event)
    • source: [view]
         evt.stopPropagation();
    • summary
      StackContainer connects to this function; if your widget contains a close button
      then clicking it should call this function.
      Note that you shouldn't override this method, but you can connect to it.
  • dijit.layout

    • type
      Object
    • summary
  • dijit

    • type
      Object
    • summary