dijit/layout/BorderContainer.js

• Provides:

  • dijit.layout.BorderContainer

• Requires:

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

• dijit._Widget

  • type

    Function

• dijit._Widget.region

  • tags: const
  • type

    String

  • summary

    Parameter for children of <code>dijit.layout.BorderContainer</code>.
    Values: &quot;top&quot;, &quot;bottom&quot;, &quot;leading&quot;, &quot;trailing&quot;, &quot;left&quot;, &quot;right&quot;, &quot;center&quot;.
    See the <code>dijit.layout.BorderContainer</code> description for details.

• dijit._Widget.layoutPriority

  • tags: const
  • type

    Number

  • summary

    Parameter for children of <code>dijit.layout.BorderContainer</code>.
    Children with a higher layoutPriority will be placed closer to the BorderContainer center,
    between children with a lower layoutPriority.

• dijit._Widget.splitter

  • tags: const
  • type

    Boolean

  • summary

    Parameter for child of <code>dijit.layout.BorderContainer</code> where region != &quot;center&quot;.
    If true, enables user to resize the widget by putting a draggable splitter between
    this widget and the region=center widget.

• dijit._Widget.minSize

  • tags: const
  • type

    Number

  • summary

    Parameter for children of <code>dijit.layout.BorderContainer</code>.
    Specifies a minimum size (in pixels) for this widget when resized by a splitter.

• dijit._Widget.prototype.maxSize

  • alias - Infinity

• dijit._Widget.maxSize

  • tags: const
  • type

    Number

  • summary

    Parameter for children of <code>dijit.layout.BorderContainer</code>.
    Specifies a maximum size (in pixels) for this widget when resized by a splitter.

• dijit.layout.BorderContainer

  • type

    Function

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

    Provides layout in up to 5 regions, a mandatory center with optional borders along its 4 sides.

  • description

    A BorderContainer is a box with a specified size, such as style="width: 500px; height: 500px;",
    that contains a child widget marked region="center" and optionally children widgets marked
    region equal to "top", "bottom", "leading", "trailing", "left" or "right".
    Children along the edges will be laid out according to width or height dimensions and may
    include optional splitters (splitter="true") to make them resizable by the user.  The remaining
    space is designated for the center region.
    
    The outer size must be specified on the BorderContainer node.  Width must be specified for the sides
    and height for the top and bottom, respectively.  No dimensions should be specified on the center;
    it will fill the remaining space.  Regions named "leading" and "trailing" may be used just like
    "left" and "right" except that they will be reversed in right-to-left environments.
    
    For complex layouts, multiple children can be specified for a single region.   In this case, the
    layoutPriority flag on the children determines which child is closer to the edge (low layoutPriority)
    and which child is closer to the center (high layoutPriority).   layoutPriority can also be used
    instead of the design attribute to conrol layout precedence of horizontal vs. vertical panes.

  • example

    	<div dojoType="dijit.layout.BorderContainer" design="sidebar" gutters="false"
                style="width: 400px; height: 300px;">
    		<div dojoType="dijit.layout.ContentPane" region="top">header text</div>
    		<div dojoType="dijit.layout.ContentPane" region="right" splitter="true" style="width: 200px;">table of contents</div>
    		<div dojoType="dijit.layout.ContentPane" region="center">client area</div>
    	</div>

• dijit.layout.BorderContainer.design

  • type

    String

  • summary

    Which design is used for the layout:
    - "headline" (default) where the top and bottom extend
    the full width of the container
    - "sidebar" where the left and right sides extend from top to bottom.

• dijit.layout.BorderContainer.gutters

  • tags: const
  • type

    Boolean

  • summary

    Give each pane a border and margin.
    Margin determined by domNode.paddingLeft.
    When false, only resizable panes have a gutter (i.e. draggable splitter) for resizing.

• dijit.layout.BorderContainer.liveSplitters

  • tags: const
  • type

    Boolean

  • summary

    Specifies whether splitters resize as you drag (true) or only upon mouseup (false)

• dijit.layout.BorderContainer.persist

  • type

    Boolean

  • summary

    Save splitter positions in a cookie.

• dijit.layout.BorderContainer.baseClass

  • type

    String

• dijit.layout.BorderContainer._splitterClass

  • type

    String

  • summary

    Optional hook to override the default Splitter widget used by BorderContainer

• dijit.layout.BorderContainer.postMixInProperties

  • type

    Function

• dijit.layout.BorderContainer.startup

  • type

    Function

• dijit.layout.BorderContainer._setupChild

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

    Function

• dijit.layout.BorderContainer.layout

  • type

    Function

• dijit.layout.BorderContainer.addChild

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

    Function

• dijit.layout.BorderContainer.removeChild

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

    Function

• dijit.layout.BorderContainer.getChildren

  • type

    Function

• dijit.layout.BorderContainer.getSplitter

  • parameters:
    • region: (typeof String)
  • summary

    Returns the widget responsible for rendering the splitter associated with region

  • tags:
  • type

    Function

• dijit.layout.BorderContainer.resize

  • parameters:
    • newSize
    • currentSize
  • type

    Function

• dijit.layout.BorderContainer.domNode

• dijit.layout.BorderContainer.cs

  • type

    Object

• dijit.layout.BorderContainer.pe

  • type

    Object

• dijit.layout.BorderContainer.pe.r

  • type

    Object

• dijit.layout.BorderContainer.pe.b

  • type

    Object

• dijit.layout.BorderContainer._layoutChildren

  • parameters:
    • changedChildId: (typeof String)

      Id of the child which should be resized because splitter was dragged.

    • changedChildSize: (typeof Number)

      The new width/height (in pixels) to make specified child

  • summary

    This is the main routine for setting size/position of each child.

  • description

    With no arguments, measures the height of top/bottom panes, the width
    of left/right panes, and then sizes all panes accordingly.
    
    With changedRegion specified (as "left", "top", "bottom", or "right"),
    it changes that region's width/height to changedRegionSize and
    then resizes other regions that were affected.

  • type

    Function

• dijit.layout.BorderContainer.destroyRecursive

  • type

    Function

• dijit.layout._Splitter

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    A draggable spacer between two items in a <code>dijit.layout.BorderContainer</code>.

  • description

    This is instantiated by `dijit.layout.BorderContainer`.  Users should not
    create it directly.

  • tags:

• dijit.layout._Splitter.container

  • tags: const
  • type

    dijit.layout.BorderContainer

  • summary

    Pointer to the parent BorderContainer

• dijit.layout._Splitter.child

  • tags: const
  • type

    dijit.layout._LayoutWidget

  • summary

    Pointer to the pane associated with this splitter

• dijit.layout._Splitter.region

  • tags: const
  • type

    String

  • summary

    Region of pane associated with this splitter.
    "top", "bottom", "left", "right".

• dijit.layout._Splitter.live

  • tags: const
  • type

    Boolean

  • summary

    If true, the child's size changes and the child widget is redrawn as you drag the splitter;
    otherwise, the size doesn't change until you drop the splitter (by mouse-up)

• dijit.layout._Splitter.templateString

  • type

    String

• dijit.layout._Splitter.postMixInProperties

  • type

    Function

• dijit.layout._Splitter.horizontal

  • type

    Object

• dijit.layout._Splitter._factor

• dijit.layout._Splitter._cookieName

  • type

    String

• dijit.layout._Splitter.buildRendering

  • type

    Function

• dijit.layout._Splitter._computeMaxSize

  • summary

    Return the maximum size that my corresponding pane can be set to

  • type

    Function

• dijit.layout._Splitter._startDrag

  • parameters:
    • e
  • type

    Function

• dijit.layout._Splitter.cover

  • type

    Object

• dijit.layout._Splitter._resize

  • type

    Object

• dijit.layout._Splitter.fake

  • type

    Object

• dijit.layout._Splitter.domNode.style

• dijit.layout._Splitter.child.minSize

  • type

    Number

• dijit.layout._Splitter._handlers

  • type

    Object

• dijit.layout._Splitter._drag

  • parameters:
    • e
    • forceResize
  • type

    Function

• dijit.layout._Splitter._onMouse

  • parameters:
    • e
  • type

    Function

• dijit.layout._Splitter._stopDrag

  • parameters:
    • e
  • type

    Function

• dijit.layout._Splitter._cleanupHandlers

  • type

    Function

• dijit.layout._Splitter._onKeyPress

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

    Function

• dijit.layout._Splitter.destroy

  • type

    Function

• dijit.layout._Gutter

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    Just a spacer div to separate side pane from center pane.
    Basically a trick to lookup the gutter/splitter width from the theme.

  • description

    Instantiated by `dijit.layout.BorderContainer`.  Users should not
    create directly.

  • tags:

• dijit.layout._Gutter.templateString

  • type

    String

• dijit.layout._Gutter.postMixInProperties

  • type

    Function

• dijit.layout._Gutter.horizontal

  • type

    Object

• dijit.layout._Gutter.buildRendering

  • type

    Function

• dijit.layout

  • type

    Object

• dijit

  • type

    Object