dijit/layout/StackController.js

• Provides:

  • dijit.layout.StackController

• Requires:

  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._Container in common
  • dijit.form.ToggleButton in common

• dijit.layout.StackController

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Container.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
    • dijit._Container: (call)
  • 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.

• dijit.layout.StackController.templateString

  • type

    String

• 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.constructor

  • constructor - constructor
  • type

    Function

• dijit.layout.StackController.buildRendering

  • type

    Function

• dijit.layout.StackController.postCreate

  • type

    Function

• dijit.layout.StackController.onStartup

  • parameters:
    • info: (typeof Object)
  • summary

    Called after StackContainer has finished initializing

  • tags:
  • type

    Function

• dijit.layout.StackController.destroy

  • type

    Function

• dijit.layout.StackController.onAddChild

  • parameters:
    • page: (typeof dijit._Widget)
    • insertIndex: (typeof Integer)
  • summary

    Called whenever a page is added to the container.
    Create button corresponding to the page.

  • tags:
  • type

    Function

• dijit.layout.StackController._currentChild

  • type

    Object

• dijit.layout.StackController.onRemoveChild

  • parameters:
    • page: (typeof dijit._Widget)
  • summary

    Called whenever a page is removed from the container.
    Remove the button corresponding to the page.

  • tags:
  • type

    Function

• dijit.layout.StackController.onSelectChild

  • parameters:
    • page: (typeof dijit._Widget)
  • summary

    Called when a page has been selected in the StackContainer, either by me or by another StackController

  • tags:
  • type

    Function

• dijit.layout.StackController.onButtonClick

  • parameters:
    • page: (typeof dijit._Widget)
  • summary

    Called whenever one of my child buttons is pressed in an attempt to select a page

  • tags:
  • type

    Function

• dijit.layout.StackController.onCloseButtonClick

  • parameters:
    • page: (typeof dijit._Widget)
  • summary

    Called whenever one of my child buttons [X] is pressed in an attempt to close a page

  • tags:
  • type

    Function

• dijit.layout.StackController.adjacent

  • parameters:
    • forward: (typeof Boolean)
  • returns

    dijit._Widget

  • summary

    Helper for onkeypress to find next/previous button

  • tags:
  • type

    Function

• dijit.layout.StackController.onkeypress

  • parameters:
    • e: (typeof Event)
  • summary

    Handle keystrokes on the page list, for advancing to next/previous button
    and closing the current page if the page is closable.

  • tags:
  • type

    Function

• dijit.layout.StackController.onContainerKeyPress

  • parameters:
    • info: (typeof Object)
  • summary

    Called when there was a keypress on the container

  • tags:
  • type

    Function

• dijit.layout.StackController.pane2button

  • type

    Object

• dijit.layout.StackController.pane2connects

  • type

    Object

• dijit.layout.StackController.pane2watches

  • type

    Object

• dijit.layout._StackButton

  • type

    Function

  • chains:
    • dijit.form.ToggleButton: (prototype)
    • dijit.form.ToggleButton: (call)
  • summary

    Internal widget used by StackContainer.

  • description

    The button-like or tab-like object you click to select or delete a page

  • tags:

• dijit.layout._StackButton.tabIndex

  • type

    String

• dijit.layout._StackButton.buildRendering

  • parameters:
    • evt: (typeof Event)
  • type

    Function

• dijit.layout._StackButton.onClick

  • parameters:
    • evt: (typeof Event)
  • 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.

  • type

    Function

• dijit.layout._StackButton.onClickCloseButton

  • parameters:
    • evt: (typeof Event)
  • 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.

  • type

    Function

• dijit.layout

  • type

    Object

• dijit

  • type

    Object