dijit/_Container.js

• Provides:

  • dijit._Container

• dijit._Container

  • type

    Function

  • summary

    Mixin for widgets that contain a set of widget children.

  • description

    Use this mixin for widgets that needs to know about and
    keep track of their widget children. Suitable for widgets like BorderContainer
    and TabContainer which contain (only) a set of child widgets.
    
    It's not suitable for widgets like ContentPane
    which contains mixed HTML (plain DOM nodes in addition to widgets),
    and where contained widgets are not necessarily directly below
    this.containerNode.   In that case calls like addChild(node, position)
    wouldn't make sense.

• dijit._Container.isContainer

  • tags:
  • type

    Boolean

  • summary

    Indicates that this widget acts as a "parent" to the descendant widgets.
    When the parent is started it will call startup() on the child widgets.
    See also <code>isLayoutContainer</code>.

• dijit._Container.buildRendering

  • type

    Function

• dijit._Container.containerNode

• dijit._Container.addChild

  • parameters:
    • widget: (typeof dijit._Widget)
    • insertIndex: (typeof int)
  • summary

    Makes the given widget a child of this widget.

  • description

    Inserts specified child widget's dom node as a child of this widget's
    container node, and possibly does other processing (such as layout).

  • type

    Function

• dijit._Container.removeChild

  • parameters:
    • widget: (typeof Widget)

      or int

  • summary

    Removes the passed widget instance from this widget but does
    not destroy it.  You can also pass in an integer indicating
    the index within the container to remove

  • type

    Function

• dijit._Container.hasChildren

  • returns

    Boolean

  • summary

    Returns true if widget has children, i.e. if this.containerNode contains something.

  • type

    Function

• dijit._Container.destroyDescendants

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

    Destroys all the widgets inside this.containerNode,
    but not this widget itself

  • type

    Function

• dijit._Container._getSiblingOfChild

  • parameters:
    • child: (typeof dijit._Widget)
    • dir: (typeof int)

      if 1, get the next sibling
      if -1, get the previous sibling

  • returns

    dijit._Widget

  • summary

    Get the next or previous widget sibling of child

  • tags:
  • type

    Function

• dijit._Container.getIndexOfChild

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

    int

  • summary

    Gets the index of the child in this container or -1 if not found

  • type

    Function

• dijit._Container.startup

  • summary

    Called after all the widgets have been instantiated and their
    dom nodes have been inserted somewhere under dojo.doc.body.
    
    Widgets should override this method to do any initialization
    dependent on other widgets existing, and then call
    this superclass method to finish things off.
    
    startup() in subclasses shouldn't do anything
    size related because the size of the widget hasn't been set yet.

  • type

    Function

• dijit

  • type

    Object