/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_layout_BorderLayout_Region({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":["Ext.layout.BorderLayout.SplitRegion"],"extends":null,"uses":[],"html":"

Subclasses

Files

This is a region of a BorderLayout that acts as a subcontainer\nwithin the layout. Each region in the layout is a component, the region itself is constructed on top\nof that component, acting like a mixin. Each region has its own layout \nthat is independent of other regions and the containing BorderLayout, and can be any of the\nvalid Ext layout types.

\n\n\n

Region size is managed automatically and cannot be changed by the user -- for\nresizable regions, see Ext.layout.BorderLayout.SplitRegion.

\n\n
Defined By

Config options

Ext.layout.BorderLayout.Region
view source
: Boolean
When a collapsed region's bar is clicked, the region's panel will be displayed as a floated\npanel that will close aga...

When a collapsed region's bar is clicked, the region's panel will be displayed as a floated\npanel that will close again once the user mouses out of that panel (or clicks out if\nautoHide = false). Setting animFloat = false will\nprevent the open and close of these floated panels from being animated (defaults to true).

\n
Ext.layout.BorderLayout.Region
view source
: Boolean
When a collapsed region's bar is clicked, the region's panel will be displayed as a floated\npanel. ...

When a collapsed region's bar is clicked, the region's panel will be displayed as a floated\npanel. If autoHide = true, the panel will automatically hide after the user mouses\nout of the panel. If autoHide = false, the panel will continue to display until the\nuser clicks outside of the panel (defaults to true).

\n
Ext.layout.BorderLayout.Region
view source
: Object
An object containing margins to apply to the region when in the collapsed state in the\nformat:\n\n{\n top: (top margi...

An object containing margins to apply to the region when in the collapsed state in the\nformat:

\n\n
{\n    top: (top margin),\n    right: (right margin),\n    bottom: (bottom margin),\n    left: (left margin)\n}
\n\n\n

May also be a string containing space-separated, numeric margin values. The order of the\nsides associated with each value matches the way CSS processes margin values.

\n\n\n

    \n
  • If there is only one value, it applies to all sides.
  • \n
  • If there are two values, the top and bottom borders are set to the first value and the\nright and left are set to the second.
  • \n
  • If there are three values, the top is set to the first value, the left and right are set\nto the second, and the bottom is set to the third.
  • \n
  • If there are four values, they apply to the top, right, bottom, and left, respectively.
  • \n

\n\n
Ext.layout.BorderLayout.Region
view source
: String
collapseMode supports two configuration values:\nundefined (default)By default, collapsible\nregions are collapsed by c...

collapseMode supports two configuration values:

    \n
  • undefined (default)
    By default, collapsible\nregions are collapsed by clicking the expand/collapse tool button that renders into the region's\ntitle bar.
  • \n
  • 'mini'
    Optionally, when collapseMode is set to\n'mini' the region's split bar will also display a small collapse button in the center of\nthe bar. In 'mini' mode the region will collapse to a thinner bar than in normal mode.\n
  • \n

\n\n

Note: if a collapsible region does not have a title bar, then set collapseMode =\n'mini' and split = true in order for the region to be collapsible\nby the user as the expand/collapse tool button (that would go in the title bar) will not be rendered.

\n\n\n

See also cmargins.

\n\n
Ext.layout.BorderLayout.Region
view source
: Boolean
true to allow the user to collapse this region (defaults to false). ...

true to allow the user to collapse this region (defaults to false). If\ntrue, an expand/collapse tool button will automatically be rendered into the title\nbar of the region, otherwise the button will not be shown.

\n\n\n

Note: that a title bar is required to display the collapse/expand toggle button -- if\nno title is specified for the region's panel, the region will only be collapsible if\ncollapseMode = 'mini' and split = true.\n\n

Defaults to: false

Ext.layout.BorderLayout.Region
view source
: Boolean
true to allow clicking a collapsed region's bar to display the region's panel floated\nabove the layout, false to forc...

true to allow clicking a collapsed region's bar to display the region's panel floated\nabove the layout, false to force the user to fully expand a collapsed region by\nclicking the expand button to see it again (defaults to true).

\n

Defaults to: true

Ext.layout.BorderLayout.Region
view source
: Object
An object containing margins to apply to the region when in the expanded state in the\nformat:\n\n{\n top: (top margin...

An object containing margins to apply to the region when in the expanded state in the\nformat:

\n\n
{\n    top: (top margin),\n    right: (right margin),\n    bottom: (bottom margin),\n    left: (left margin)\n}
\n\n\n

May also be a string containing space-separated, numeric margin values. The order of the\nsides associated with each value matches the way CSS processes margin values:

\n\n\n

    \n
  • If there is only one value, it applies to all sides.
  • \n
  • If there are two values, the top and bottom borders are set to the first value and the\nright and left are set to the second.
  • \n
  • If there are three values, the top is set to the first value, the left and right are set\nto the second, and the bottom is set to the third.
  • \n
  • If there are four values, they apply to the top, right, bottom, and left, respectively.
  • \n

\n\n\n

Defaults to:

\n\n\n
{top:0, right:0, bottom:0, left:0}\n
\n\n
Ext.layout.BorderLayout.Region
view source
: Number
The minimum allowable height in pixels for this region (defaults to 50)\nmaxHeight may also be specified. ...

The minimum allowable height in pixels for this region (defaults to 50)\nmaxHeight may also be specified.


\n\n

Note: setting the minSize /\nmaxSize supersedes any specified\nminHeight / maxHeight.

\n\n

Defaults to: 50

Ext.layout.BorderLayout.Region
view source
: Number
The minimum allowable width in pixels for this region (defaults to 50). ...

The minimum allowable width in pixels for this region (defaults to 50).\nmaxWidth may also be specified.

\n\n\n
\n\n\n

Note: setting the minSize /\nmaxSize supersedes any specified\nminWidth / maxWidth.

\n\n

Defaults to: 50

Ext.layout.BorderLayout.Region
view source
: Boolean
true to create a SplitRegion and\ndisplay a 5px wide Ext.SplitBar between this region and its neighbor, allowing the u...

true to create a SplitRegion and\ndisplay a 5px wide Ext.SplitBar between this region and its neighbor, allowing the user to\nresize the regions dynamically. Defaults to false creating a\nRegion.

\n\n\n
\n\n\n

Notes:

\n\n\n
    \n
  • this configuration option is ignored if region='center'
  • \n
  • when split == true, it is common to specify a\nminSize and maxSize\nfor the BoxComponent representing the region. These are not native\nconfigs of BoxComponent, and are used only by this class.
  • \n
  • if collapseMode = 'mini' requires split = true to reserve space\nfor the collapse tool
  • \n
\n\n

Defaults to: false

Defined By

Properties

Ext.layout.BorderLayout.Region
view source
: Boolean
True if this region is collapsed. ...

True if this region is collapsed. Read-only.

\n

Defaults to: false

Ext.layout.BorderLayout.Region
view source
: Layout
This region's layout. ...

This region's layout. Read-only.

\n
Ext.layout.BorderLayout.Region
view source
: Ext.Panel
This region's panel. ...

This region's panel. Read-only.

\n
Ext.layout.BorderLayout.Region
view source
: String
This region's layout position (north, south, east, west or center). ...

This region's layout position (north, south, east, west or center). Read-only.

\n
Defined By

Methods

Ext.layout.BorderLayout.Region
view source
new( layout, config, position ) : Ext.layout.BorderLayout.Region
Create a new Region. ...

Create a new Region.

\n

Parameters

  • layout : Layout

    The BorderLayout instance that is managing this Region.

    \n
  • config : Object

    The configuration options

    \n
  • position : String

    The region position. Valid values are: north, south,\neast, west and center. Every BorderLayout\nmust have a center region for the primary content -- all other regions are optional.

    \n

Returns

Ext.layout.BorderLayout.Region
view source
( ) : Object
Returns the current margins for this region. ...

Returns the current margins for this region. If the region is collapsed, the\ncmargins (collapsed margins) value will be returned, otherwise the\nmargins value will be returned.

\n

Returns

  • Object

    An object containing the element's margins: {left: (left\nmargin), top: (top margin), right: (right margin), bottom: (bottom margin)}

    \n
Ext.layout.BorderLayout.Region
view source
( ) : Number
Returns the minimum allowable height for this region. ...

Returns the minimum allowable height for this region.

\n

Returns

Ext.layout.BorderLayout.Region
view source
( ) : Number
Returns the minimum allowable width for this region. ...

Returns the minimum allowable width for this region.

\n

Returns

Ext.layout.BorderLayout.Region
view source
( ) : Object
Returns the current size of this region. ...

Returns the current size of this region. If the region is collapsed, the size of the\ncollapsedEl will be returned, otherwise the size of the region's panel will be returned.

\n

Returns

  • Object

    An object containing the element's size: {width: (element width),\nheight: (element height)}

    \n
Ext.layout.BorderLayout.Region
view source
( ) : Boolean
True if this region is currently visible, else false. ...

True if this region is currently visible, else false.

\n

Returns

  • Boolean
    \n
Ext.layout.BorderLayout.Region
view source
( panel )
Sets the specified panel as the container element for this region. ...

Sets the specified panel as the container element for this region.

\n

Parameters

Ext.layout.BorderLayout.Region
view source
( cb )
If this Region is floatable, and this Region has been slid into floating visibility, then this method slides\nthis reg...

If this Region is floatable, and this Region has been slid into floating visibility, then this method slides\nthis region back into its collapsed state.

\n

Parameters

  • cb : Object
    \n
Ext.layout.BorderLayout.Region
view source
( )
If this Region is floatable, this method slides this Region into full visibility over the top\nof the center Region wh...

If this Region is floatable, this method slides this Region into full visibility over the top\nof the center Region where it floats until either slideIn is called, or other regions of the layout\nare clicked, or the mouse exits the Region.

\n
","superclasses":[],"meta":{},"requires":[],"html_meta":{},"statics":{"property":[],"cfg":[],"css_var":[],"method":[],"event":[],"css_mixin":[]},"files":[{"href":"BorderLayout.html#Ext-layout-BorderLayout-Region","filename":"BorderLayout.js"}],"linenr":229,"members":{"property":[{"tagname":"property","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"isCollapsed","id":"property-isCollapsed"},{"tagname":"property","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"layout","id":"property-layout"},{"tagname":"property","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"panel","id":"property-panel"},{"tagname":"property","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"position","id":"property-position"}],"cfg":[{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"animFloat","id":"cfg-animFloat"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"autoHide","id":"cfg-autoHide"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"cmargins","id":"cfg-cmargins"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"collapseMode","id":"cfg-collapseMode"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"collapsible","id":"cfg-collapsible"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"floatable","id":"cfg-floatable"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"margins","id":"cfg-margins"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"minHeight","id":"cfg-minHeight"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"minWidth","id":"cfg-minWidth"},{"tagname":"cfg","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"split","id":"cfg-split"}],"css_var":[],"method":[{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"getMargins","id":"method-getMargins"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"getMinHeight","id":"method-getMinHeight"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"getMinWidth","id":"method-getMinWidth"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"getSize","id":"method-getSize"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"isVisible","id":"method-isVisible"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"setPanel","id":"method-setPanel"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"slideIn","id":"method-slideIn"},{"tagname":"method","owner":"Ext.layout.BorderLayout.Region","meta":{},"name":"slideOut","id":"method-slideOut"}],"event":[],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.layout.BorderLayout.Region","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.layout.BorderLayout.Region","mixins":[],"mixedInto":[]});