| Package: | Ext |
| Class: | ReaderLayout |
| Extends: | BorderLayout |
| Defined In: | ReaderLayout.js |
var reader = new Ext.ReaderLayout();
var CP = Ext.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(); | Property | Defined By | |
|---|---|---|
| monitorWindowResize : Boolean | LayoutManager | |
| false to disable window resize monitoring | ||
| Method | Defined By | |
|---|---|---|
ReaderLayout( Object config, [String/HTMLElement/Element container] ) |
ReaderLayout | |
| Create a new ReaderLayout | ||
add( String target, Ext.ContentPanel panel ) : Ext.ContentPanel |
BorderLayout | |
| Adds a ContentPanel (or subclass) to this layout. | ||
addEvents( Object object ) : void |
Observable | |
| Used to define events on this Observable | ||
addListener( String eventName, Function handler, [Object scope], [Object options] ) : void |
Observable | |
| Appends an event handler to this component | ||
addRegion( String target, Object config ) : BorderLayoutRegion |
BorderLayout | |
| Creates and adds a new region if it doesn't already exist. | ||
batchAdd( Object regions ) : void |
BorderLayout | |
| Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config object sh... | ||
| beginUpdate() : void | LayoutManager | |
| Suspend the LayoutManager from doing auto-layouts while making multiple add or remove calls | ||
endUpdate( Boolean noLayout ) : void |
LayoutManager | |
| Restore auto-layouts and optionally disable the manager from performing a layout | ||
findPanel( String panelId ) : Ext.ContentPanel |
BorderLayout | |
| Searches all regions for a panel with the specified id | ||
fireEvent( String eventName, Object... args ) : Boolean |
Observable | |
| Fires the specified event with the passed parameters (minus the event name). | ||
| getEl() : Ext.Element | LayoutManager | |
| Returns the Element this layout is bound to. | ||
getRegion( String target ) : Ext.LayoutRegion |
LayoutManager | |
| Returns the specified region. | ||
| getViewSize() : Object | LayoutManager | |
| Returns the size of the current view. This method normalizes document.body and element embedded layouts and performs ... | ||
hasListener( String eventName ) : Boolean |
Observable | |
| Checks to see if this object has any listeners for a specified event | ||
| isUpdating() : Boolean | LayoutManager | |
| Returns true if this layout is currently being updated | ||
| layout() : void | BorderLayout | |
| Performs a layout update. | ||
on( String eventName, Function handler, [Object scope], [Object options] ) : void |
Observable | |
| Appends an event handler to this element (shorthand for addListener) | ||
| purgeListeners() : void | Observable | |
| Removes all listeners for this object | ||
remove( String target, Number/String/Ext.ContentPanel panel ) : Ext.ContentPanel |
BorderLayout | |
| Remove a ContentPanel (or subclass) to this layout. | ||
removeListener( String eventName, Function handler, [Object scope] ) : void |
Observable | |
| Removes a listener | ||
restoreState( [Ext.state.Provider provider] ) : void |
BorderLayout | |
| Restores this layout's state using Ext.state.Manager or the state provided by the passed provider. | ||
showPanel( String/ContentPanel panelId ) : Ext.ContentPanel |
BorderLayout | |
| Searches all regions for a panel with the specified id and activates (shows) it. | ||
un( String eventName, Function handler, [Object scope] ) : void |
Observable | |
| Removes a listener (shorthand for removeListener) | ||
| Event | Defined By | |
|---|---|---|
layout : ( Ext.LayoutManager this ) |
LayoutManager | |
| Fires when a layout is performed. | ||
regioncollapsed : ( Ext.LayoutRegion region ) |
LayoutManager | |
| Fires when a region is collapsed. | ||
regionexpanded : ( Ext.LayoutRegion region ) |
LayoutManager | |
| Fires when a region is expanded. | ||
regionresized : ( Ext.LayoutRegion region, Number newSize ) |
LayoutManager | |
| Fires when the user resizes a region. | ||
public Boolean monitorWindowResize
public function ReaderLayout( Object config, [String/HTMLElement/Element container] )
config : Objectcontainer : String/HTMLElement/Elementpublic function add( String target, Ext.ContentPanel panel )
target : Stringpanel : Ext.ContentPanelExt.ContentPanelpublic function addEvents( Object object )
object : Objectvoidpublic function addListener( String eventName, Function handler, [Object scope], [Object options] )
eventName : Stringhandler : Functionscope : Objectoptions : Object
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
});voidpublic function addRegion( String target, Object config )
target : Stringconfig : ObjectBorderLayoutRegionpublic function batchAdd( Object regions )
// Create the main layout
var layout = new Ext.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'
}
});
regions : Objectvoidpublic function beginUpdate()
voidpublic function endUpdate( Boolean noLayout )
noLayout : Booleanvoidpublic function findPanel( String panelId )
panelId : StringExt.ContentPanelpublic function fireEvent( String eventName, Object... args )
eventName : Stringargs : Object...Booleanpublic function getEl()
Ext.Elementpublic function getRegion( String target )
target : StringExt.LayoutRegionpublic function getViewSize()
Objectpublic function hasListener( String eventName )
eventName : StringBooleanpublic function isUpdating()
Booleanpublic function layout()
voidpublic function on( String eventName, Function handler, [Object scope], [Object options] )
eventName : Stringhandler : Functionscope : Objectoptions : Objectvoidpublic function purgeListeners()
voidpublic function remove( String target, Number/String/Ext.ContentPanel panel )
target : Stringpanel : Number/String/Ext.ContentPanelExt.ContentPanelpublic function removeListener( String eventName, Function handler, [Object scope] )
eventName : Stringhandler : Functionscope : Objectvoidpublic function restoreState( [Ext.state.Provider provider] )
provider : Ext.state.Providervoidpublic function showPanel( String/ContentPanel panelId )
panelId : String/ContentPanelExt.ContentPanelpublic function un( String eventName, Function handler, [Object scope] )
eventName : Stringhandler : Functionscope : Objectvoidpublic event layout
this : Ext.LayoutManagerpublic event regioncollapsed
region : Ext.LayoutRegionpublic event regionexpanded
region : Ext.LayoutRegionpublic event regionresized
region : Ext.LayoutRegionnewSize : Number