Properties

Methods

Events

Config Options

Direct Link

ContainerLayout
  BorderLayout

Class CQ.Ext.layout.BorderLayout

Package:	CQ.Ext.layout
Class:	BorderLayout
Extends:	CQ.Ext.layout.ContainerLayout
Clientlib:	cq.widgets

This is a multi-pane, application-oriented UI layout style that supports multiple nested panels, automatic split bars between regions and built-in expanding and collapsing of regions.

This class is intended to be extended or created via the layout:'border' CQ.Ext.Container.layout config, and should generally not need to be created directly via the new keyword.

BorderLayout does not have any direct config options (other than inherited ones). All configuration options available for customizing the BorderLayout are at the CQ.Ext.layout.BorderLayout.Region and CQ.Ext.layout.BorderLayout.SplitRegion levels.

Example usage:

var myBorderPanel = new CQ.Ext.Panel({
    renderTo: document.body,
    width: 700,
    height: 500,
    title: 'Border Layout',
    layout: 'border',
    items: [{
        title: 'South Region is resizable',
        region: 'south',     // position for region
        height: 100,
        split: true,         // enable resizing
        minSize: 75,         // defaults to 50
        maxSize: 150,
        margins: '0 5 5 5'
    },{
        // xtype: 'panel' implied by default
        title: 'West Region is collapsible',
        region:'west',
        margins: '5 0 0 5',
        width: 200,
        collapsible: true,   // make collapsible
        cmargins: '5 5 0 5', // adjust top margin when collapsed
        id: 'west-region-container',
        layout: 'fit',
        unstyled: true
    },{
        title: 'Center Region',
        region: 'center',     // center region is required, no width/height specified
        xtype: 'container',
        layout: 'fit',
        margins: '5 5 0 0'
    }]
});

Notes:

Any container using the BorderLayout must have a child item with region:'center'. The child item in the center region will always be resized to fill the remaining space not used by the other regions in the layout.
Any child items with a region of west or east must have width defined (an integer representing the number of pixels that the region should take up).
Any child items with a region of north or south must have height defined.
The regions of a BorderLayout are fixed at render time and thereafter, its child Components may not be removed or added. To add/remove Components within a BorderLayout, have them wrapped by an additional Container which is directly managed by the BorderLayout. If the region is to be collapsible, the Container used directly by the BorderLayout manager should be a Panel. In the following example a Container (an CQ.Ext.Panel) is added to the west region:
```
wrc = CQ.Ext.getCmp('west-region-container');
wrc.removeAll();
wrc.add({
    title: 'Added Panel',
    html: 'Some content'
});
wrc.doLayout();
```
To reference a Region:
```
wr = myBorderPanel.layout.west;
```

Config Options

Config Options		Defined By
	extraCls : String An optional extra CSS class that will be added to the container. This can be useful for adding customized styles to t... An optional extra CSS class that will be added to the container. This can be useful for adding customized styles to the container or any of its children using standard CSS rules. See CQ.Ext.Component.ctCls also. Note: `extraCls` defaults to `''` except for the following classes which assign a value by default: Absolute Layout : `'x-abs-layout-item'` Box Layout : `'x-box-item'` Column Layout : `'x-column'` To configure the above Classes with an extra CSS class append to the default. For example, for ColumnLayout: `extraCls: 'x-column custom-class'`	ContainerLayout
	renderHidden : Boolean True to hide each contained item on render (defaults to false).	ContainerLayout

Public Properties

Property		Defined By
	fieldTpl : CQ.Ext.Template The CQ.Ext.Template used by Field rendering layout classes (such as CQ.Ext.layout.FormLayout) to create the DOM struc... The CQ.Ext.Template used by Field rendering layout classes (such as CQ.Ext.layout.FormLayout) to create the DOM structure of a fully wrapped, labeled and styled form Field. A default Template is supplied, but this may be overriden to create custom field structures. The template processes values returned from CQ.Ext.layout.FormLayout.getTemplateArgs.	ContainerLayout
	monitorResize : Object This monitorResize flag will be renamed soon as to avoid confusion with the Container version which hooks onWindowRes... This monitorResize flag will be renamed soon as to avoid confusion with the Container version which hooks onWindowResize to doLayout monitorResize flag in this context attaches the resize event between a container and it's layout	ContainerLayout

Public Methods

Method		Defined By
	parseMargins( `Number\|String v` ) : Object Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, ... Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result) Parameters: `v` : Number\|String The encoded margins Returns: `Object` An object with margin sizes for top, right, bottom and left	ContainerLayout

Public Events

This class has no public events.