Class Ext.SplitLayoutRegion

Package:	Ext
Class:	SplitLayoutRegion
Extends:	LayoutRegion
Defined In:	SplitLayoutRegion.js

Adds a splitbar and other (private) useful functionality to a LayoutRegion

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	bodyEl : Ext.Element	LayoutRegion
	This regions body element	LayoutRegion
	collapsedEl : Ext.Element	LayoutRegion
	This region's collapsed element	LayoutRegion
	el : Ext.Element	LayoutRegion
	This regions container element	LayoutRegion
	panels : Ext.util.MixedCollection	BasicLayoutRegion
	A collection of panels in this region.	BasicLayoutRegion
	split : Ext.SplitBar	SplitLayoutRegion
	The SplitBar for this region	SplitLayoutRegion
	titleEl : Ext.Element	LayoutRegion
	This regions title element	LayoutRegion
	titleTextEl : HTMLElement	LayoutRegion
	This regions title text element	LayoutRegion

Public Methods

Method		Defined By
	add(`ContentPanel... panel`) : Ext.ContentPanel	BasicLayoutRegion
	Add the passed ContentPanel(s)	BasicLayoutRegion
	addEvents(`Object object`) : void	Observable
	Copies any events from the passed object onto this object if they do not already exist. The passed object must also ...	Observable
	addListener(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	collapse([`Boolean skipAnim`]) : void	LayoutRegion
	Collapses this region.	LayoutRegion
	expand(`Ext.EventObject e`, [`Boolean skipAnim`]) : void	LayoutRegion
	Expand this region if it was previously collapsed.	LayoutRegion
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	getActivePanel() : Ext.ContentPanel	BasicLayoutRegion
	Get the active panel for this region.	BasicLayoutRegion
	getEl() : Ext.Element	BasicLayoutRegion
	Returns the container element for this region.	BasicLayoutRegion
	getPanel(`Number/String/ContentPanel panel`) : Ext.ContentPanel	BasicLayoutRegion
	Returns the panel specified or null if it's not in this region.	BasicLayoutRegion
	getPosition() : String	BasicLayoutRegion
	Returns this regions position (north/south/east/west/center).	BasicLayoutRegion
	getSplitBar() : Ext.SplitBar	SplitLayoutRegion
	Returns the SplitBar for this region.	SplitLayoutRegion
	getTabs() : Ext.TabPanel	LayoutRegion
	Returns the TabPanel component used by this region	LayoutRegion
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	hasPanel(`Number/String/ContentPanel panel`) : Boolean	BasicLayoutRegion
	Returns true if the panel is in this region.	BasicLayoutRegion
	hide() : void	LayoutRegion
	Hides this region.	LayoutRegion
	hidePanel(`Number/String/ContentPanel panel`) : void	LayoutRegion
	Hides the tab for the specified panel.	LayoutRegion
	isVisible() : Boolean	BasicLayoutRegion
	Returns true if this region is currently visible.	BasicLayoutRegion
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	remove(`Number/String/ContentPanel panel`, `Boolean preservePanel`) : Ext.ContentPanel	BasicLayoutRegion
	Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.	BasicLayoutRegion
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	resizeTo(`Number newSize`) : void	BasicLayoutRegion
	Resizes the region to the specified size. For vertical regions (west, east) this adjusts the width, for horizontal (...	BasicLayoutRegion
	setCollapsedTitle() : void	LayoutRegion
	Updates the collapsed text for north/south regions (used with collapsedTitle config option)	LayoutRegion
	show() : void	LayoutRegion
	Shows this region if it was previously hidden.	LayoutRegion
	showPanel(`Number/String/ContentPanel panelId`) : Ext.ContentPanel	BasicLayoutRegion
	Show the specified panel.	BasicLayoutRegion
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable
	unhidePanel(`Number/String/ContentPanel panel`) : void	LayoutRegion
	Unhides the tab for a previously hidden panel.	LayoutRegion

Public Events

Event		Defined By
	beforeremove : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`, `Object e`)	BasicLayoutRegion
	Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.	BasicLayoutRegion
	collapsed : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region is collapsed.	BasicLayoutRegion
	expanded : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region is expanded.	BasicLayoutRegion
	invalidated : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when the layout for this region is changed.	BasicLayoutRegion
	panelactivated : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`)	BasicLayoutRegion
	Fires when a panel is activated.	BasicLayoutRegion
	paneladded : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`)	BasicLayoutRegion
	Fires when a panel is added.	BasicLayoutRegion
	panelremoved : (`Ext.LayoutRegion this`, `Ext.ContentPanel panel`)	BasicLayoutRegion
	Fires when a panel is removed.	BasicLayoutRegion
	resized : (`Ext.LayoutRegion this`, `Number newSize`)	BasicLayoutRegion
	Fires when the user resizes this region.	BasicLayoutRegion
	slidehide : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region slides out of view.	BasicLayoutRegion
	slideshow : (`Ext.LayoutRegion this`)	BasicLayoutRegion
	Fires when this region is slid into view.	BasicLayoutRegion
	visibilitychange : (`Ext.LayoutRegion this`, `Boolean visibility`)	BasicLayoutRegion
	Fires when this region is shown or hidden	BasicLayoutRegion

Config Options

Config Options		Defined By
	alwaysShowTabs : Boolean	LayoutRegion
	True to always display tabs even when only 1 panel (defaults to false)	LayoutRegion
	animate : Boolean	LayoutRegion
	True to animate expand/collapse (defaults to false)	LayoutRegion
	autoHide : Boolean	LayoutRegion
	False to disable autoHide when the mouse leaves the "floated" region (defaults to true)	LayoutRegion
	autoScroll : Boolean	LayoutRegion
	True to enable overflow scrolling (defaults to false)	LayoutRegion
	closeOnTab : Boolean	LayoutRegion
	True to place the close icon on the tabs instead of the region titlebar (defaults to false)	LayoutRegion
	cmargins : Object	LayoutRegion
	Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {...	LayoutRegion
	collapsedTitle : String	LayoutRegion
	Optional string message to display in the collapsed block of a north or south region	LayoutRegion
	collapsible : Boolean	LayoutRegion
	False to disable collapsing (defaults to true)	LayoutRegion
	disableTabTips : Boolean	LayoutRegion
	True to disable tab tooltips	LayoutRegion
	floatable : Boolean	LayoutRegion
	False to disable floating (defaults to true)	LayoutRegion
	hidden : Boolean	LayoutRegion
	True to start the region hidden	LayoutRegion
	hideTabs : Boolean	LayoutRegion
	True to hide the tab strip (defaults to false)	LayoutRegion
	hideWhenEmpty : Boolean	LayoutRegion
	True to hide the region when it has no panels	LayoutRegion
	margins : Object	LayoutRegion
	Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})	LayoutRegion
	minTabWidth : Number	LayoutRegion
	The minimum tab width (defaults to 40)	LayoutRegion
	preferredTabWidth : Number	LayoutRegion
	The preferred tab width (defaults to 150)	LayoutRegion
	preservePanels : Boolean	LayoutRegion
	True to preserve removed panels so they can be readded later (defaults to false)	LayoutRegion
	resizeTabs : Boolean	LayoutRegion
	True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within the spa...	LayoutRegion
	showPin : Boolean	LayoutRegion
	True to show a pin button	LayoutRegion
	tabPosition : String	LayoutRegion
	"top" or "bottom" (defaults to "bottom")	LayoutRegion
	title : String	LayoutRegion
	The title for the region (overrides panel titles)	LayoutRegion
	titlebar : Boolean	LayoutRegion
	True to display a title bar (defaults to true)	LayoutRegion

Property Details

bodyEl

public Ext.Element bodyEl

This regions body element

This property is defined by LayoutRegion.

collapsedEl

public Ext.Element collapsedEl

This region's collapsed element

This property is defined by LayoutRegion.

el

public Ext.Element el

This regions container element

This property is defined by LayoutRegion.

panels

public Ext.util.MixedCollection panels

A collection of panels in this region.

This property is defined by BasicLayoutRegion.

split

public Ext.SplitBar split

The SplitBar for this region

This property is defined by SplitLayoutRegion.

titleEl

public Ext.Element titleEl

This regions title element

This property is defined by LayoutRegion.

titleTextEl

public HTMLElement titleTextEl

This regions title text element

This property is defined by LayoutRegion.

Method Details

add

public function add(ContentPanel... panel)

Add the passed ContentPanel(s)

Parameters:

panel : ContentPanel...
The ContentPanel(s) to add (you can pass more than one)

Returns:

Ext.ContentPanel
The panel added (if only one was added)

This method is defined by BasicLayoutRegion.

addEvents

public function addEvents(Object object)

Copies any events from the passed object onto this object if they do not already exist. The passed object must also inherit from Observable for this method to have any effect.

Parameters:

object : Object
The object from which to copy events

Returns:

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object options])

Appends an event handler to this component

Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes
options : Object
(optional)

Returns:

void

This method is defined by Observable.

collapse

public function collapse([Boolean skipAnim])

Collapses this region.

Parameters:

skipAnim : Boolean
(optional) true to collapse the element without animation (if animate is true)

Returns:

void

This method is defined by LayoutRegion.

expand

public function expand(Ext.EventObject e, [Boolean skipAnim])

Expand this region if it was previously collapsed.

Parameters:

e : Ext.EventObject
The event that triggered the expand (or null if calling manually)
skipAnim : Boolean
(optional) true to expand the element without animation (if animate is true)

Returns:

void

This method is defined by LayoutRegion.

fireEvent

public function fireEvent(String eventName, Object... args)

Fires the specified event with the passed parameters (minus the event name).

Parameters:

eventName : String
args : Object...
Variable number of parameters are passed to handlers

Returns:

Boolean
returns false if any of the handlers return false otherwise it returns true

This method is defined by Observable.

getActivePanel

public function getActivePanel()

Get the active panel for this region.

Parameters:

None.

Returns:

Ext.ContentPanel
The active panel or null

This method is defined by BasicLayoutRegion.

getEl

public function getEl()

Returns the container element for this region.

Parameters:

None.

Returns:

Ext.Element

This method is defined by BasicLayoutRegion.

getPanel

public function getPanel(Number/String/ContentPanel panel)

Returns the panel specified or null if it's not in this region.

Parameters:

panel : Number/String/ContentPanel
The panels index, id or the panel itself

Returns:

Ext.ContentPanel

This method is defined by BasicLayoutRegion.

getPosition

public function getPosition()

Returns this regions position (north/south/east/west/center).

Parameters:

None.

Returns:

String

This method is defined by BasicLayoutRegion.

getSplitBar

public function getSplitBar()

Returns the SplitBar for this region.

Parameters:

None.

Returns:

Ext.SplitBar

This method is defined by SplitLayoutRegion.

getTabs

public function getTabs()

Returns the TabPanel component used by this region

Parameters:

None.

Returns:

Ext.TabPanel

This method is defined by LayoutRegion.

hasListener

public function hasListener(String eventName)

Checks to see if this object is currently listening for a specified event

Parameters:

eventName : String
The name of the event to check for

Returns:

Boolean
True if the event is being listened for, else false

This method is defined by Observable.

hasPanel

public function hasPanel(Number/String/ContentPanel panel)

Returns true if the panel is in this region.

Parameters:

panel : Number/String/ContentPanel
The panels index, id or the panel itself

Returns:

Boolean

This method is defined by BasicLayoutRegion.

hide

public function hide()

Hides this region.

Parameters:

None.

Returns:

void

This method is defined by LayoutRegion.

hidePanel

public function hidePanel(Number/String/ContentPanel panel)

Hides the tab for the specified panel.

Parameters:

panel : Number/String/ContentPanel
The panels index, id or the panel itself

Returns:

void

This method is defined by LayoutRegion.

isVisible

public function isVisible()

Returns true if this region is currently visible.

Parameters:

None.

Returns:

Boolean

This method is defined by BasicLayoutRegion.

on

public function on(String eventName, Function handler, [Object options])

Appends an event handler to this element (shorthand for addListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes
options : Object
(optional)

Returns:

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

Removes all listeners for this object

Parameters:

None.

Returns:

void

This method is defined by Observable.

remove

public function remove(Number/String/ContentPanel panel, Boolean preservePanel)

Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.

Parameters:

panel : Number/String/ContentPanel
The panels index, id or the panel itself
preservePanel : Boolean
Overrides the config preservePanel option

Returns:

Ext.ContentPanel
The panel that was removed

This method is defined by BasicLayoutRegion.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])

Removes a listener

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

resizeTo

public function resizeTo(Number newSize)

Resizes the region to the specified size. For vertical regions (west, east) this adjusts the width, for horizontal (north, south) the height.

Parameters:

newSize : Number
The new width or height

Returns:

void

This method is defined by BasicLayoutRegion.

setCollapsedTitle

public function setCollapsedTitle()

Updates the collapsed text for north/south regions (used with collapsedTitle config option)

Parameters:

None.

Returns:

void

This method is defined by LayoutRegion.

show

public function show()

Shows this region if it was previously hidden.

Parameters:

None.

Returns:

void

This method is defined by LayoutRegion.

showPanel

public function showPanel(Number/String/ContentPanel panelId)

Show the specified panel.

Parameters:

panelId : Number/String/ContentPanel
The panels index, id or the panel itself

Returns:

Ext.ContentPanel
The shown panel or null

This method is defined by BasicLayoutRegion.

un

public function un(String eventName, Function handler, [Object scope])

Removes a listener (shorthand for removeListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

unhidePanel

public function unhidePanel(Number/String/ContentPanel panel)

Unhides the tab for a previously hidden panel.

Parameters:

panel : Number/String/ContentPanel
The panels index, id or the panel itself

Returns:

void

This method is defined by LayoutRegion.

Event Details

beforeremove

public event beforeremove

Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion
panel : Ext.ContentPanel
The panel
e : Object
The cancel event object

This event is defined by BasicLayoutRegion.

collapsed

public event collapsed

Fires when this region is collapsed.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion

This event is defined by BasicLayoutRegion.

expanded

public event expanded

Fires when this region is expanded.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion

This event is defined by BasicLayoutRegion.

invalidated

public event invalidated

Fires when the layout for this region is changed.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion

This event is defined by BasicLayoutRegion.

panelactivated

public event panelactivated

Fires when a panel is activated.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion
panel : Ext.ContentPanel
The activated panel

This event is defined by BasicLayoutRegion.

paneladded

public event paneladded

Fires when a panel is added.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion
panel : Ext.ContentPanel
The panel

This event is defined by BasicLayoutRegion.

panelremoved

public event panelremoved

Fires when a panel is removed.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion
panel : Ext.ContentPanel
The panel

This event is defined by BasicLayoutRegion.

resized

public event resized

Fires when the user resizes this region.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion
newSize : Number
The new size (width for east/west, height for north/south)

This event is defined by BasicLayoutRegion.

slidehide

public event slidehide

Fires when this region slides out of view.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion

This event is defined by BasicLayoutRegion.

slideshow

public event slideshow

Fires when this region is slid into view.

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion

This event is defined by BasicLayoutRegion.

visibilitychange

public event visibilitychange

Fires when this region is shown or hidden

Subscribers will be called with the following parameters:

this : Ext.LayoutRegion
visibility : Boolean
true or false

This event is defined by BasicLayoutRegion.