Package: | Ext |
Class: | SplitLayoutRegion |
Extends: | LayoutRegion |
Defined In: | SplitLayoutRegion.js |
Property | Defined By | |
---|---|---|
bodyEl : Ext.Element | LayoutRegion | |
This region's body element | ||
collapsedEl : Ext.Element | LayoutRegion | |
This region's collapsed element | ||
el : Ext.Element | LayoutRegion | |
This region's container element | ||
panels : Ext.util.MixedCollection | BasicLayoutRegion | |
A collection of panels in this region. | ||
split : Ext.SplitBar | SplitLayoutRegion | |
The SplitBar for this region | ||
titleEl : Ext.Element | LayoutRegion | |
This region's title element | ||
titleTextEl : HTMLElement | LayoutRegion | |
This region's title text element |
Method | Defined By | |
---|---|---|
add( ContentPanel... panel ) : Ext.ContentPanel |
BasicLayoutRegion | |
Add the passed ContentPanel(s) | ||
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 | ||
collapse( [Boolean skipAnim ] ) : void |
LayoutRegion | |
Collapses this region. | ||
expand( Ext.EventObject e , [Boolean skipAnim ] ) : void |
LayoutRegion | |
Expands this region if it was previously collapsed. | ||
fireEvent( String eventName , Object... args ) : Boolean |
Observable | |
Fires the specified event with the passed parameters (minus the event name). | ||
getActivePanel() : Ext.ContentPanel | BasicLayoutRegion | |
Get the active panel for this region. | ||
getEl() : Ext.Element | BasicLayoutRegion | |
Returns the container element for this region. | ||
getPanel( Number/String/ContentPanel panel ) : Ext.ContentPanel |
BasicLayoutRegion | |
Returns the panel specified or null if it's not in this region. | ||
getPosition() : String | BasicLayoutRegion | |
Returns this regions position (north/south/east/west/center). | ||
getSplitBar() : Ext.SplitBar | SplitLayoutRegion | |
Returns the Ext.SplitBar for this region. | ||
getTabs() : Ext.TabPanel | LayoutRegion | |
Returns the TabPanel component used by this region | ||
hasListener( String eventName ) : Boolean |
Observable | |
Checks to see if this object has any listeners for a specified event | ||
hasPanel( Number/String/ContentPanel panel ) : Boolean |
BasicLayoutRegion | |
Returns true if the panel is in this region. | ||
hide() : void | LayoutRegion | |
Hides this region. | ||
hidePanel( Number/String/ContentPanel panel ) : void |
LayoutRegion | |
Hides the tab for the specified panel. | ||
isVisible() : Boolean | BasicLayoutRegion | |
Returns true if this region is currently visible. | ||
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( 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. | ||
removeListener( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener | ||
resizeTo( Number newSize ) : void |
BasicLayoutRegion | |
Resizes the region to the specified size. For vertical regions (west, east) this adjusts the width, for horizontal (... | ||
setCollapsedTitle( [String title ] ) : void |
LayoutRegion | |
Updates the title for collapsed north/south regions (used with collapsedTitle config option) | ||
show() : void | LayoutRegion | |
Shows this region if it was previously hidden. | ||
showPanel( Number/String/ContentPanel panelId ) : Ext.ContentPanel |
BasicLayoutRegion | |
Show the specified panel. | ||
un( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener (shorthand for removeListener) | ||
unhidePanel( Number/String/ContentPanel panel ) : void |
LayoutRegion | |
Unhides the tab for a previously hidden panel. |
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. | ||
collapsed : ( Ext.LayoutRegion this ) |
BasicLayoutRegion | |
Fires when this region is collapsed. | ||
expanded : ( Ext.LayoutRegion this ) |
BasicLayoutRegion | |
Fires when this region is expanded. | ||
invalidated : ( Ext.LayoutRegion this ) |
BasicLayoutRegion | |
Fires when the layout for this region is changed. | ||
panelactivated : ( Ext.LayoutRegion this , Ext.ContentPanel panel ) |
BasicLayoutRegion | |
Fires when a panel is activated. | ||
paneladded : ( Ext.LayoutRegion this , Ext.ContentPanel panel ) |
BasicLayoutRegion | |
Fires when a panel is added. | ||
panelremoved : ( Ext.LayoutRegion this , Ext.ContentPanel panel ) |
BasicLayoutRegion | |
Fires when a panel is removed. | ||
resized : ( Ext.LayoutRegion this , Number newSize ) |
BasicLayoutRegion | |
Fires when the user resizes this region. | ||
slidehide : ( Ext.LayoutRegion this ) |
BasicLayoutRegion | |
Fires when this region slides out of view. | ||
slideshow : ( Ext.LayoutRegion this ) |
BasicLayoutRegion | |
Fires when this region is slid into view. | ||
visibilitychange : ( Ext.LayoutRegion this , Boolean visibility ) |
BasicLayoutRegion | |
Fires when this region is shown or hidden |
Config Options | Defined By | |
---|---|---|
alwaysShowTabs : Boolean | LayoutRegion | |
True to always display tabs even when there is only 1 panel (defaults to false) | ||
animate : Boolean | LayoutRegion | |
True to animate expand/collapse (defaults to false) | ||
autoHide : Boolean | LayoutRegion | |
False to disable auto hiding when the mouse leaves the "floated" region (defaults to true) | ||
autoScroll : Boolean | LayoutRegion | |
True to enable overflow scrolling (defaults to false) | ||
closeOnTab : Boolean | LayoutRegion | |
True to place the close icon on the tabs instead of the region titlebar (defaults to false) | ||
cmargins : Object | LayoutRegion | |
Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {... | ||
collapsed : Boolean | LayoutRegion | |
True to set the initial display to collapsed (defaults to false) | ||
collapsedTitle : String | LayoutRegion | |
Optional string message to display in the collapsed block of a north or south region | ||
collapsible : Boolean | LayoutRegion | |
False to disable collapsing (defaults to true) | ||
disableTabTips : Boolean | LayoutRegion | |
True to disable tab tooltips | ||
floatable : Boolean | LayoutRegion | |
False to disable floating (defaults to true) | ||
hidden : Boolean | LayoutRegion | |
True to start the region hidden (defaults to false) | ||
hideTabs : Boolean | LayoutRegion | |
True to hide the tab strip (defaults to false) | ||
hideWhenEmpty : Boolean | LayoutRegion | |
True to hide the region when it has no panels | ||
margins : Object | LayoutRegion | |
Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0}) | ||
minTabWidth : Number | LayoutRegion | |
The minimum tab width (defaults to 40) | ||
preferredTabWidth : Number | LayoutRegion | |
The preferred tab width (defaults to 150) | ||
preservePanels : Boolean | LayoutRegion | |
True to preserve removed panels so they can be readded later (defaults to false) | ||
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... | ||
showPin : Boolean | LayoutRegion | |
True to show a pin button | ||
tabPosition : String | LayoutRegion | |
"top" or "bottom" (defaults to "bottom") | ||
title : String | LayoutRegion | |
The title for the region (overrides panel titles) | ||
titlebar : Boolean | LayoutRegion | |
True to display a title bar (defaults to true) |
public Ext.Element bodyEl
public Ext.Element collapsedEl
public Ext.util.MixedCollection panels
public Ext.SplitBar split
public Ext.Element titleEl
public HTMLElement titleTextEl
public function add( ContentPanel... panel
)
panel
: ContentPanel...Ext.ContentPanel
public function addEvents( Object object
)
object
: Objectvoid
public 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
});
void
public function collapse( [Boolean skipAnim
] )
skipAnim
: Booleanvoid
public function expand( Ext.EventObject e
, [Boolean skipAnim
] )
e
: Ext.EventObjectskipAnim
: Booleanvoid
public function fireEvent( String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function getActivePanel()
Ext.ContentPanel
public function getEl()
Ext.Element
public function getPanel( Number/String/ContentPanel panel
)
panel
: Number/String/ContentPanelExt.ContentPanel
public function getPosition()
String
public function getSplitBar()
Ext.SplitBar
public function getTabs()
Ext.TabPanel
public function hasListener( String eventName
)
eventName
: StringBoolean
public function hasPanel( Number/String/ContentPanel panel
)
panel
: Number/String/ContentPanelBoolean
public function hide()
void
public function hidePanel( Number/String/ContentPanel panel
)
panel
: Number/String/ContentPanelvoid
public function isVisible()
Boolean
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Objectvoid
public function purgeListeners()
void
public function remove( Number/String/ContentPanel panel
, Boolean preservePanel
)
panel
: Number/String/ContentPanelpreservePanel
: BooleanExt.ContentPanel
public function removeListener( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function resizeTo( Number newSize
)
newSize
: Numbervoid
public function setCollapsedTitle( [String title
] )
title
: Stringvoid
public function show()
void
public function showPanel( Number/String/ContentPanel panelId
)
panelId
: Number/String/ContentPanelExt.ContentPanel
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function unhidePanel( Number/String/ContentPanel panel
)
panel
: Number/String/ContentPanelvoid
public event beforeremove
this
: Ext.LayoutRegionpanel
: Ext.ContentPanele
: Objectpublic event collapsed
this
: Ext.LayoutRegionpublic event expanded
this
: Ext.LayoutRegionpublic event invalidated
this
: Ext.LayoutRegionpublic event panelactivated
this
: Ext.LayoutRegionpanel
: Ext.ContentPanelpublic event paneladded
this
: Ext.LayoutRegionpanel
: Ext.ContentPanelpublic event panelremoved
this
: Ext.LayoutRegionpanel
: Ext.ContentPanelpublic event resized
this
: Ext.LayoutRegionnewSize
: Numberpublic event slidehide
this
: Ext.LayoutRegionpublic event slideshow
this
: Ext.LayoutRegionpublic event visibilitychange
this
: Ext.LayoutRegionvisibility
: BooleanalwaysShowTabs : Boolean
animate : Boolean
autoHide : Boolean
autoScroll : Boolean
closeOnTab : Boolean
cmargins : Object
collapsed : Boolean
collapsedTitle : String
collapsible : Boolean
disableTabTips : Boolean
floatable : Boolean
hidden : Boolean
hideTabs : Boolean
hideWhenEmpty : Boolean
margins : Object
minTabWidth : Number
preferredTabWidth : Number
preservePanels : Boolean
resizeTabs : Boolean
tabPosition : String
title : String
titlebar : Boolean