Class Roo.BorderLayout

Create a new Roo.BorderLayout

Parameters:

String/HTMLElement/Element container

The container this layout is bound to

Object config

Configuration options

Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling
the beginUpdate and endUpdate calls internally. The key to this method is the panels property that can be
provided with each region config, which allows you to add ContentPanel configs in addition to the region configs
during creation. The following code is equivalent to the constructor-based example at the beginning of this class:

// shorthand
var CP = Roo.ContentPanel;

var layout = Roo.BorderLayout.create({
    north: {
        initialSize: 25,
        titlebar: false,
        panels: [new CP("north", "North")]
    },
    west: {
        split:true,
        initialSize: 200,
        minSize: 175,
        maxSize: 400,
        titlebar: true,
        collapsible: true,
        panels: [new CP("west", {title: "West"})]
    },
    east: {
        split:true,
        initialSize: 202,
        minSize: 175,
        maxSize: 400,
        titlebar: true,
        collapsible: true,
        panels: [new CP("autoTabs", {title: "Auto Tabs", closable: true})]
    },
    south: {
        split:true,
        initialSize: 100,
        minSize: 100,
        maxSize: 200,
        titlebar: true,
        collapsible: true,
        panels: [new CP("south", {title: "South", closable: true})]
    },
    center: {
        titlebar: true,
        autoScroll:true,
        resizeTabs: true,
        minTabWidth: 50,
        preferredTabWidth: 150,
        panels: [
            new CP("center1", {title: "Close Me", closable: true}),
            new CP("center2", {title: "Center Panel", closable: false})
        ]
    }
}, document.body);

layout.getRegion("center").showPanel("center1");

Parameters:

config

targetEl

Adds a ContentPanel (or subclass) to this layout.

Parameters:

String target

The target region key (north, south, east, west or center).

Roo.ContentPanel panel

The panel to add

Returns:

Roo.ContentPanel The added panel

Creates and adds a new region if it doesn't already exist.

Parameters:

String target

The target region key (north, south, east, west or center).

Object config

The regions config object

Returns:

BorderLayoutRegion The new region

Adds a xtype elements to the layout.

layout.addxtype({
       xtype : 'ContentPanel',
       region: 'west',
       items: [ .... ]
   }
);

layout.addxtype({
        xtype : 'NestedLayoutPanel',
        region: 'west',
        layout: {
           center: { },
           west: { }   
        },
        items : [ ... list of content panels or nested layout panels.. ]
   }
);

Parameters:

Object cfg

Xtype definition of item to add.

Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config
object should contain properties for each region to add ContentPanels to, and each property's value should be
a valid ContentPanel config object. Example:

// Create the main layout
var layout = new Roo.BorderLayout('main-ct', {
    west: {
        split:true,
        minSize: 175,
        titlebar: true
    },
    center: {
        title:'Components'
    }
}, 'main-ct');

// Create and add multiple ContentPanels at once via configs
layout.batchAdd({
   west: {
       id: 'source-files',
       autoCreate:true,
       title:'Ext Source Files',
       autoScroll:true,
       fitToFrame:true
   },
   center : {
       el: cview,
       autoScroll:true,
       fitToFrame:true,
       toolbar: tb,
       resizeEl:'cbody'
   }
});

Parameters:

Object regions

An object containing ContentPanel configs by region name

Searches all regions for a panel with the specified id

Parameters:

String panelId

Returns:

Roo.ContentPanel The panel or null if it wasn't found

Performs a layout update.

Remove a ContentPanel (or subclass) to this layout.

Parameters:

String target

The target region key (north, south, east, west or center).

Number/String/Roo.ContentPanel panel

The index, id or panel to remove

Returns:

Roo.ContentPanel The removed panel

Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.

Parameters:

Roo.state.Provider provider

(optional) An alternate state provider

Searches all regions for a panel with the specified id and activates (shows) it.

Parameters:

String/ContentPanel panelId

The panels id or the panel itself

Returns:

Roo.ContentPanel The shown panel or null