Class Ext.LayoutManager

Package:	Ext
Class:	LayoutManager
Extends:	Observable
Subclasses:	BorderLayout
Defined In:	LayoutManager.js

Base class for layout managers.

Properties - Methods - Events

Public Properties

Property		Defined By
	monitorWindowResize : Boolean	LayoutManager
	false to disable window resize monitoring	LayoutManager

Public Methods

Method		Defined By
	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
	beginUpdate() : void	LayoutManager
	Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls	LayoutManager
	endUpdate(`Boolean noLayout`) : void	LayoutManager
	Restore auto-layouts and optionally disable the manager from performing a layout	LayoutManager
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	getEl() : Ext.Element	LayoutManager
	Returns the element this layout is bound to.	LayoutManager
	getRegion(`String target`) : Ext.LayoutRegion	LayoutManager
	Returns the specified region.	LayoutManager
	getViewSize() : Object	LayoutManager
	Returns the size of the current view, This method normalizes document.body and element embedded layouts and performs ...	LayoutManager
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	isUpdating() : Boolean	LayoutManager
	Returns true if this layout is currently being updated	LayoutManager
	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
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	layout : (`Ext.LayoutManager this`)	LayoutManager
	Fires when a layout is performed.	LayoutManager
	regioncollapsed : (`Ext.LayoutRegion region`)	LayoutManager
	Fires when a region is collapsed.	LayoutManager
	regionexpanded : (`Ext.LayoutRegion region`)	LayoutManager
	Fires when a region is expanded.	LayoutManager
	regionresized : (`Ext.LayoutRegion region`, `Number newSize`)	LayoutManager
	Fires when the user resizes a region.	LayoutManager

Property Details

monitorWindowResize

public Boolean monitorWindowResize

false to disable window resize monitoring

This property is defined by LayoutManager.

Method Details

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.

beginUpdate

public function beginUpdate()

Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls

Parameters:

None.

Returns:

void

This method is defined by LayoutManager.

endUpdate

public function endUpdate(Boolean noLayout)

Restore auto-layouts and optionally disable the manager from performing a layout

Parameters:

noLayout : Boolean
true to disable a layout update

Returns:

void

This method is defined by LayoutManager.

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.

getEl

public function getEl()

Returns the element this layout is bound to.

Parameters:

None.

Returns:

Ext.Element

This method is defined by LayoutManager.

getRegion

public function getRegion(String target)

Returns the specified region.

Parameters:

target : String
The region key

Returns:

Ext.LayoutRegion

This method is defined by LayoutManager.

getViewSize

public function getViewSize()

Returns the size of the current view, This method normalizes document.body and element embedded layouts and performs box-model adjustments.

Parameters:

None.

Returns:

Object
The size as an object {width: (the width), height: (the height)}

This method is defined by LayoutManager.

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.

isUpdating

public function isUpdating()

Returns true if this layout is currently being updated

Parameters:

None.

Returns:

Boolean

This method is defined by LayoutManager.

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.

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.

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.

Event Details

layout

public event layout

Fires when a layout is performed.

Subscribers will be called with the following parameters:

this : Ext.LayoutManager

This event is defined by LayoutManager.

regioncollapsed

public event regioncollapsed

Fires when a region is collapsed.

Subscribers will be called with the following parameters:

region : Ext.LayoutRegion

This event is defined by LayoutManager.

regionexpanded

public event regionexpanded

Fires when a region is expanded.

Subscribers will be called with the following parameters:

region : Ext.LayoutRegion

This event is defined by LayoutManager.

regionresized

public event regionresized

Fires when the user resizes a region.

Subscribers will be called with the following parameters:

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

This event is defined by LayoutManager.