dijit/layout/StackContainer.js

• Provides:

  • dijit.layout.StackContainer

• Requires:

  • dijit._Templated in common
  • dijit.layout._LayoutWidget in common
  • dojo.cookie in common
  • dijit.layout.StackController in common

• dijit._Widget

  • type

    Function

• dijit._Widget.selected

  • type

    Boolean

  • summary

    Parameter for children of <code>dijit.layout.StackContainer</code> or subclasses.
    Specifies that this widget should be the initially displayed pane.
    Note: to change the selected child use <code>dijit.layout.StackContainer.selectChild</code>

• dijit._Widget.closable

  • type

    Boolean

  • summary

    Parameter for children of <code>dijit.layout.StackContainer</code> or subclasses.
    True if user can close (destroy) this child, such as (for example) clicking the X on the tab.

• dijit._Widget.iconClass

  • type

    String

  • summary

    Parameter for children of <code>dijit.layout.StackContainer</code> or subclasses.
    CSS Class specifying icon to use in label associated with this pane.

• dijit._Widget.showTitle

  • type

    Boolean

  • summary

    Parameter for children of <code>dijit.layout.StackContainer</code> or subclasses.
    When true, display title of this widget as tab label etc., rather than just using
    icon specified in iconClass

• dijit.layout.StackContainer

  • type

    Function

  • chains:
    • dijit.layout._LayoutWidget: (prototype)
    • dijit.layout._LayoutWidget: (call)
  • summary

    A container that has multiple children, but shows only
    one child at a time

  • description

    A container for widgets (ContentPanes, for example) That displays
    only one Widget at a time.
    
    Publishes topics [widgetId]-addChild, [widgetId]-removeChild, and [widgetId]-selectChild
    
    Can be base class for container, Wizard, Show, etc.

• dijit.layout.StackContainer.doLayout

  • type

    Boolean

  • summary

    If true, change the size of my currently displayed child to match my size

• dijit.layout.StackContainer.persist

  • type

    Boolean

  • summary

    Remembers the selected child across sessions

• dijit.layout.StackContainer.baseClass

  • type

    String

• dijit.layout.StackContainer.selectedChildWidget

  • tags: readonly
  • type

    dijit._Widget

  • summary

    References the currently selected child widget, if any.
    Adjust selected child with selectChild() method.

• dijit.layout.StackContainer.buildRendering

  • type

    Function

• dijit.layout.StackContainer.postCreate

  • type

    Function

• dijit.layout.StackContainer.startup

  • type

    Function

• dijit.layout.StackContainer.resize

  • type

    Function

• dijit.layout.StackContainer._hasBeenShown

  • type

    Object

• dijit.layout.StackContainer._setupChild

  • parameters:
    • child: (typeof dijit._Widget)
  • type

    Function

• dijit.layout.StackContainer.addChild

  • parameters:
    • child: (typeof dijit._Widget)
    • insertIndex: (typeof Integer)
  • type

    Function

• dijit.layout.StackContainer.removeChild

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

    Function

• dijit.layout.StackContainer.selectChild

  • parameters:
    • page: (typeof dijit._Widget|String)

      Reference to child widget or id of child widget

    • animate: (typeof Boolean)
  • returns

    If child has an href, promise that fires when the child's href finishes loading

  • summary

    Show the given widget (which must be one of my children)

  • type

    Function

• dijit.layout.StackContainer._transition

  • parameters:
    • newWidget: (typeof dijit._Widget)
    • oldWidget: (typeof dijit._Widget)
    • animate: (typeof Boolean)
  • returns

    If child has an href, promise that fires when the child's href finishes loading

  • summary

    Hide the old widget and display the new widget.
    Subclasses should override this.

  • tags: extension
  • type

    Function

• dijit.layout.StackContainer._adjacent

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

    dijit._Widget

  • summary

    Gets the next/previous child widget in this container from the current selection.

  • type

    Function

• dijit.layout.StackContainer.forward

  • summary

    Advance to next page.

  • type

    Function

• dijit.layout.StackContainer.back

  • summary

    Go back to previous page.

  • type

    Function

• dijit.layout.StackContainer._onKeyPress

  • parameters:
    • e
  • type

    Function

• dijit.layout.StackContainer.layout

  • type

    Function

• dijit.layout.StackContainer._showChild

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

    Show the specified child by changing it's CSS, and call _onShow()/onShow() so
    it can do any updates it needs regarding loading href's etc.

  • return_summary

    Promise that fires when page has finished showing, or true if there's no href

  • type

    Function

• dijit.layout.StackContainer._hideChild

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

    Hide the specified child by changing it's CSS, and call _onHide() so
    it's notified.

  • type

    Function

• dijit.layout.StackContainer.closeChild

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

    Callback when user clicks the [X] to remove a page.
    If onClose() returns true then remove and destroy the child.

  • tags:
  • type

    Function

• dijit.layout.StackContainer.destroyDescendants

  • parameters:
    • preserveDom: (typeof Boolean)
  • type

    Function

• dijit.layout

  • type

    Object

• dijit

  • type

    Object