Roo.util.Observable
Roo.LayoutManager
Roo.BorderLayout
Roo.ReaderLayout

Class Roo.ReaderLayout

Package:	Roo
Defined In:	Roo/ReaderLayout.js.
Class:	ReaderLayout
Extends:	Roo.BorderLayout

This is a pre-built layout that represents a classic, 5-pane application. It consists of a header, a primary
center region containing two nested regions (a top one for a list view and one for item preview below),
and regions on either side that can be used for navigation, application commands, informational displays, etc.
The setup and configuration work exactly the same as it does for a {link Roo.BorderLayout} - this class simply
expedites the setup of the overall layout and regions for this common application style.
Example:


var reader = new Roo.ReaderLayout();
var CP = Roo.ContentPanel;  // shortcut for adding

reader.beginUpdate();
reader.add("north", new CP("north", "North"));
reader.add("west", new CP("west", {title: "West"}));
reader.add("east", new CP("east", {title: "East"}));

reader.regions.listView.add(new CP("listView", "List"));
reader.regions.preview.add(new CP("preview", "Preview"));
reader.endUpdate();

Class Comments / Notes => [Add Your comment/notes about this class]

Config Options (Usually are also Properties)
Options		Defined By
	listeners : Object list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... }`	Roo.util.Observable

Public Methods
Method		Defined By
	new Roo.ReaderLayout (Object *config, String/HTMLElement/Element container) Create a new Roo.ReaderLayout Create a new Roo.ReaderLayout Parameters: Object config* Configuration options String/HTMLElement/Element container (optional) The container this layout is bound to (defaults to document.body if omitted)
	add (String *target, Roo.ContentPanel panel) : Roo.ContentPanel Adds a ContentPanel (or subclass) to this layout. 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	Roo.BorderLayout
	addEvents (Object *object) Used to define events on this Observable Used to define events on this Observable Parameters: Object object* The object with the events defined	Roo.util.Observable
	addListener (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this component Appends an event handler to this component Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional) An object containing handler configuration properties. This may contain any of the following properties: scope {Object} The scope in which to execute the handler function. The handler function's "this" context. delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires. single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an {link Roo.util.DelayedTask} delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. `el.on({ 'click': { fn: this.onClick, scope: this, delay: 100 }, 'mouseover': { fn: this.onMouseOver, scope: this }, 'mouseout': { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax which passes the same scope object to all handlers: `el.on({ 'click': this.onClick, 'mouseover': this.onMouseOver, 'mouseout': this.onMouseOut, scope: this });`	Roo.util.Observable
	addRegion (String *target, Object config) : BorderLayoutRegion Creates and adds a new region if it doesn't already exist. 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	Roo.BorderLayout
	addxtype (Object *cfg) Adds a xtype elements to the layout. 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.	Roo.BorderLayout
	batchAdd (Object *regions) Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. 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	Roo.BorderLayout
	beginUpdate () Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls	Roo.LayoutManager
	endUpdate (Boolean *noLayout) Restore auto-layouts and optionally disable the manager from performing a layout Restore auto-layouts and optionally disable the manager from performing a layout Parameters: Boolean noLayout* true to disable a layout update	Roo.LayoutManager
	findPanel (String *panelId) : Roo.ContentPanel Searches all regions for a panel with the specified id 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	Roo.BorderLayout
	fireEvent (String *eventName, Object... args) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: String eventName* Object... args Variable number of parameters are passed to handlers Returns: Boolean returns false if any of the handlers return false otherwise it returns true	Roo.util.Observable
	getEl () : Roo.Element Returns the Element this layout is bound to. Returns the Element this layout is bound to. Returns: Roo.Element	Roo.LayoutManager
	getRegion (String *target) : Roo.LayoutRegion Returns the specified region. Returns the specified region. Parameters: String target* The region key ('center', 'north', 'south', 'east' or 'west') Returns: Roo.LayoutRegion	Roo.LayoutManager
	getViewSize () : Object Returns the size of the current view. Returns the size of the current view. This method normalizes document.body and element embedded layouts and performs box-model adjustments. Returns: Object The size as an object {width: (the width), height: (the height)}	Roo.LayoutManager
	hasListener (String *eventName) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: String eventName* The name of the event to check for Returns: Boolean True if the event is being listened for, else false	Roo.util.Observable
	isUpdating () : Boolean Returns true if this layout is currently being updated Returns true if this layout is currently being updated Returns: Boolean	Roo.LayoutManager
	layout () Performs a layout update. Performs a layout update.	Roo.BorderLayout
	on (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional)	Roo.util.Observable
	purgeListeners () Removes all listeners for this object Removes all listeners for this object	Roo.util.Observable
	remove (String *target, Number/String/Roo.ContentPanel panel) : Roo.ContentPanel Remove a ContentPanel (or subclass) to this layout. 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	Roo.BorderLayout
	removeListener (String *eventName, Function handler, Object scope) Removes a listener Removes a listener Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable
	restoreState (Roo.state.Provider *provider) Restores this layout's state using Roo.state.Manager or the state provided by the passed provider. 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	Roo.BorderLayout
	showPanel (String/ContentPanel *panelId) : Roo.ContentPanel Searches all regions for a panel with the specified id and activates (shows) it. 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	Roo.BorderLayout
	un (String *eventName, Function handler, Object scope) Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable

Events
Event		Defined By
	layout (Roo.LayoutManager *this) Fires when a layout is performed. Fires when a layout is performed. Parameters: Roo.LayoutManager this*	Roo.LayoutManager
	regioncollapsed (Roo.LayoutRegion *region) Fires when a region is collapsed. Fires when a region is collapsed. Parameters: Roo.LayoutRegion region* The collapsed region	Roo.LayoutManager
	regionexpanded (Roo.LayoutRegion *region) Fires when a region is expanded. Fires when a region is expanded. Parameters: Roo.LayoutRegion region* The expanded region	Roo.LayoutManager
	regionresized (Roo.LayoutRegion *region, Number newSize) Fires when the user resizes a region. Fires when the user resizes a region. Parameters: Roo.LayoutRegion region* The resized region Number newSize The new size (width for east/west, height for north/south)	Roo.LayoutManager

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT) Based on JsDoc Toolkit