Class Ext.ContentPanel

Package:	Ext
Class:	ContentPanel
Extends:	Observable
Subclasses:	GridPanel, NestedLayoutPanel
Defined In:	ContentPanels.js

A basic ContentPanel element.

Properties - Methods - Events - Config Options

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	ContentPanel(`String/HTMLElement/Element el`, `String/Object config`, [`String content`])	ContentPanel
	Create a new ContentPanel.	ContentPanel
	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
	destroy() : void	ContentPanel
	Destroys this panel	ContentPanel
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	getEl() : Ext.Element	ContentPanel
	Returns this panel's element	ContentPanel
	getId() : String	ContentPanel
	Returns this panel's id	ContentPanel
	getTitle() : String	ContentPanel
	Returns this panel's title	ContentPanel
	getToolbar() : Ext.Toolbar	ContentPanel
	Returns the toolbar for this Panel if one was configured.	ContentPanel
	getUpdateManager() : Ext.UpdateManager	ContentPanel
	Get the Ext.UpdateManager for this panel. Enables you to perform Ajax updates.	ContentPanel
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	isClosable() : Boolean	ContentPanel
	Returns true is this panel was configured to be closable	ContentPanel
	load(`Object/String/Function url`, [`String/Object params`], [`Function callback`], [`Boolean discardUrl`]) : Ext.ContentPanel	ContentPanel
	Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use ...	ContentPanel
	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
	refresh() : void	ContentPanel
	Force a content refresh from the URL specified in the setUrl() method. Will fail silently if the setUrl method has no...	ContentPanel
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	setContent(`String content`, [`Boolean loadScripts`]) : void	ContentPanel
	Updates this panel's element	ContentPanel
	setTitle(`String title`) : void	ContentPanel
	Set this panel's title	ContentPanel
	setUrl(`String/Function url`, [`String/Object params`], [`Boolean loadOnce`]) : Ext.UpdateManager	ContentPanel
	Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded fro...	ContentPanel
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	activate : (`Ext.ContentPanel this`)	ContentPanel
	Fires when this panel is activated.	ContentPanel
	deactivate : (`Ext.ContentPanel this`)	ContentPanel
	Fires when this panel is activated.	ContentPanel
	resize : (`Ext.ContentPanel this`, `Number width`, `Number height`)	ContentPanel
	Fires when this panel is resized if fitToFrame is true.	ContentPanel

Config Options

Config Options		Defined By
	adjustments : Array	ContentPanel
	Values to add to the width/height when doing a fitToFrame (default is [0, 0])	ContentPanel
	autoCreate : Boolean/Object	ContentPanel
	True to auto generate the DOM element for this panel, or a DomHelper config of the element to create	ContentPanel
	autoScroll : Boolean	ContentPanel
	True to scroll overflow in this panel (use with fitToFrame)	ContentPanel
	background : Boolean	ContentPanel
	True if the panel should not be activated when it is added (defaults to false)	ContentPanel
	closable : Boolean	ContentPanel
	True if the panel can be closed/removed	ContentPanel
	fitContainer : Boolean	ContentPanel
	When using fitToFrame and resizeEl, you can also fit the parent container (defaults to false)	ContentPanel
	fitToFrame : Boolean	ContentPanel
	True for this panel to adjust its size to fit when the region resizes (defaults to false)	ContentPanel
	loadOnce : Boolean	ContentPanel
	Calls When used with "url", calls setUrl() with this value	ContentPanel
	params : String/Object	ContentPanel
	When used with "url", calls setUrl() with this value	ContentPanel
	resizeEl : String/HTMLElement/Element	ContentPanel
	An element to resize if fitToFrame is true (instead of this panel's element)	ContentPanel
	title : String	ContentPanel
	The title for this panel	ContentPanel
	toolbar : Toolbar	ContentPanel
	A toolbar for this panel	ContentPanel
	url : String	ContentPanel
	Calls setUrl() with this value	ContentPanel

Constructor Details

ContentPanel

public function ContentPanel(String/HTMLElement/Element el, String/Object config, [String content])

Create a new ContentPanel.

Parameters:

el : String/HTMLElement/Element
The container element for this panel
config : String/Object
A string to set only the title or a config object
content : String
(optional) Set the HTML content for this panel

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.

destroy

public function destroy()

Destroys this panel

Parameters:

None.

Returns:

void

This method is defined by ContentPanel.

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 this panel's element

Parameters:

None.

Returns:

Ext.Element

This method is defined by ContentPanel.

getId

public function getId()

Returns this panel's id

Parameters:

None.

Returns:

String

This method is defined by ContentPanel.

getTitle

public function getTitle()

Returns this panel's title

Parameters:

None.

Returns:

String

This method is defined by ContentPanel.

getToolbar

public function getToolbar()

Returns the toolbar for this Panel if one was configured.

Parameters:

None.

Returns:

Ext.Toolbar

This method is defined by ContentPanel.

getUpdateManager

public function getUpdateManager()

Get the Ext.UpdateManager for this panel. Enables you to perform Ajax updates.

Parameters:

None.

Returns:

Ext.UpdateManager
The UpdateManager

This method is defined by ContentPanel.

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.

isClosable

public function isClosable()

Returns true is this panel was configured to be closable

Parameters:

None.

Returns:

Boolean

This method is defined by ContentPanel.

load

public function load(Object/String/Function url, [String/Object params], [Function callback], [Boolean discardUrl])

Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use setUrl.

Parameters:

url : Object/String/Function
The url for this request or a function to call to get the url or a config object containing any of the following options:
```
 panel.load({
 url: "your-url.php",
 params: {param1: "foo", param2: "bar"}, // or a URL encoded string
 callback: yourFunction,
 scope: yourObject, //(optional scope) 
 discardUrl: false, 
 nocache: false,
 text: "Loading...",
 timeout: 30,
 scripts: false
 }); 
```
The only required property is url. The optional properties nocache, text and scripts are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.
params : String/Object
(optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}
callback : Function
(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)
discardUrl : Boolean
(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.

Returns:

Ext.ContentPanel
this

This method is defined by ContentPanel.

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.

refresh

public function refresh()

Force a content refresh from the URL specified in the setUrl() method. Will fail silently if the setUrl method has not been called. This does not activate the panel, just updates its content.

Parameters:

None.

Returns:

void

This method is defined by ContentPanel.

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.

setContent

public function setContent(String content, [Boolean loadScripts])

Updates this panel's element

Parameters:

content : String
The new content
loadScripts : Boolean
(optional) true to look for and process scripts

Returns:

void

This method is defined by ContentPanel.

setTitle

public function setTitle(String title)

Set this panel's title

Parameters:

title : String

Returns:

void

This method is defined by ContentPanel.

setUrl

public function setUrl(String/Function url, [String/Object params], [Boolean loadOnce])

Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.

Parameters:

url : String/Function
The url to load the content from or a function to call to get the url
params : String/Object
(optional) The string params for the update call or an object of the params. See Ext.UpdateManager.update for more details. (Defaults to null)
loadOnce : Boolean
(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)

Returns:

Ext.UpdateManager
The UpdateManager

This method is defined by ContentPanel.

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

activate

public event activate

Fires when this panel is activated.

Subscribers will be called with the following parameters:

this : Ext.ContentPanel

This event is defined by ContentPanel.

deactivate

public event deactivate

Fires when this panel is activated.

Subscribers will be called with the following parameters:

this : Ext.ContentPanel

This event is defined by ContentPanel.

resize

public event resize

Fires when this panel is resized if fitToFrame is true.

Subscribers will be called with the following parameters:

this : Ext.ContentPanel
width : Number
The width after any component adjustments
height : Number
The height after any component adjustments

This event is defined by ContentPanel.