dijit/layout/_LayoutWidget.js

• Provides:

  • dijit.layout._LayoutWidget

• Requires:

  • dijit._Widget in common
  • dijit._Container in common
  • dijit._Contained in common

• dijit.layout._LayoutWidget

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Container.prototype: (prototype)
    • dijit._Contained.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Container: (call)
    • dijit._Contained: (call)
  • summary

    Base class for a _Container widget which is responsible for laying out its children.
    Widgets which mixin this code must define layout() to manage placement and sizing of the children.

• dijit.layout._LayoutWidget.baseClass

  • tags: extension
  • type

    String

  • summary

    This class name is applied to the widget's domNode
    and also may be used to generate names for sub nodes,
    for example dijitTabContainer-content.

• dijit.layout._LayoutWidget.isLayoutContainer

  • tags:
  • type

    Boolean

  • summary

    Indicates that this widget is going to call resize() on its
    children widgets, setting their size, when they become visible.

• dijit.layout._LayoutWidget.buildRendering

  • type

    Function

• dijit.layout._LayoutWidget.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.layout._LayoutWidget.getParent

• dijit.layout._LayoutWidget.resize

  • parameters:
    • changeSize: (typeof Object)

      Sets the widget to this margin-box size and position.
      May include any/all of the following properties:
      	{w: int, h: int, l: int, t: int}

    • resultSize: (typeof Object)

      The margin-box size of this widget after applying changeSize (if
      changeSize is specified).  If caller knows this size and
      passes it in, we don't need to query the browser to get the size.
      	{w: int, h: int}

  • summary

    Call this to resize a widget, or after its size has changed.

  • description

    Change size mode:
    When changeSize is specified, changes the marginBox of this widget
    and forces it to relayout its contents accordingly.
    changeSize may specify height, width, or both.
    
    If resultSize is specified it indicates the size the widget will
    become after changeSize has been applied.
    
    Notification mode:
    When changeSize is null, indicates that the caller has already changed
    the size of the widget, or perhaps it changed because the browser
    window was resized.  Tells widget to relayout its contents accordingly.
    
    If resultSize is also specified it indicates the size the widget has
    become.
    
    In either mode, this method also:
    1. Sets this._borderBox and this._contentBox to the new size of
    the widget.  Queries the current domNode size if necessary.
    2. Calls layout() to resize contents (and maybe adjust child widgets).

  • type

    Function

• dijit.layout._LayoutWidget.domNode

• dijit.layout._LayoutWidget.domNode.style.top

  • type

    String

• dijit.layout._LayoutWidget.domNode.style.left

  • type

    String

• dijit.layout._LayoutWidget._borderBox

  • type

    Object

• dijit.layout._LayoutWidget._contentBox

  • type

    Object

• dijit.layout._LayoutWidget.layout

  • summary

    Widgets override this method to size and position their contents/children.
    When this is called this._contentBox is guaranteed to be set (see resize()).
    
    This is called after startup(), and also when the widget's size has been
    changed.

  • tags: extension
  • type

    Function

• dijit.layout._LayoutWidget._setupChild

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

    Common setup for initial children and children which are added after startup

  • tags: extension
  • type

    Function

• dijit.layout._LayoutWidget.addChild

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

    Function

• dijit.layout._LayoutWidget.removeChild

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

    Function

• dijit.layout.marginBox2contentBox

  • parameters:
    • node: (typeof DomNode)
    • mb: (typeof Object)
  • summary

    Given the margin-box size of a node, return its content box size.
    Functions like dojo.contentBox() but is more reliable since it doesn't have
    to wait for the browser to compute sizes.

  • type

    Function

• dijit.layout.layoutChildren

  • parameters:
    • container: (typeof DomNode)

      parent node

    • dim: (typeof Object)

      {l, t, w, h} object specifying dimensions of container into which to place children

    • children: (typeof Widget[])

      an array of Widgets or at least objects containing:
      * domNode: pointer to DOM node to position
      * region or layoutAlign: position to place DOM node
      * resize(): (optional) method to set size of node
      * id: (optional) Id of widgets, referenced from resize object, below.

    • changedRegionId: (typeof String)

      If specified, the slider for the region with the specified id has been dragged, and thus
      the region's height or width should be adjusted according to changedRegionSize

    • changedRegionSize: (typeof Number)

      See changedRegionId.

  • type

    Function

• dijit.layout

  • type

    Object

• dijit

  • type

    Object