Roo.util.Observable
Roo.ContentPanel

Class Roo.ContentPanel

Package:	Roo
Defined In:	Roo/ContentPanel.js.
Class:	ContentPanel
Subclasses:	Roo.GridPanel, Roo.NestedLayoutPanel, Roo.TreePanel
Extends:	Roo.util.Observable

A basic ContentPanel element.

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

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

Public Methods
Method		Defined By
	new Roo.ContentPanel (String/HTMLElement/Roo.Element el, String/Object *config, String content, String region) Create a new Roo.ContentPanel Create a new Roo.ContentPanel Parameters: String/HTMLElement/Roo.Element el The container element for this panel String/Object config* A string to set only the title or a config object String content (optional) Set the HTML content for this panel String region (optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)
	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
	addxtype (Object *cfg) Adds a xtype elements to the panel - currently only supports Forms, View, JsonView. Adds a xtype elements to the panel - currently only supports Forms, View, JsonView. `layout.addxtype({ xtype : 'Form', items: [ .... ] } );` Parameters: Object cfg* Xtype definition of item to add.	Roo.ContentPanel
	destroy () Destroys this panel Destroys this panel	Roo.ContentPanel
	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 this panel's element - used by regiosn to add. Returns this panel's element - used by regiosn to add. Returns: Roo.Element	Roo.ContentPanel
	getId () : String Returns this panel's id Returns this panel's id Returns: String	Roo.ContentPanel
	getTitle () : String Returns this panel's title Returns this panel's title Returns: String	Roo.ContentPanel
	getToolbar () : Roo.Toolbar Returns the toolbar for this Panel if one was configured. Returns the toolbar for this Panel if one was configured. Returns: Roo.Toolbar	Roo.ContentPanel
	getUpdateManager () : Roo.UpdateManager Get the {link Roo.UpdateManager} for this panel. Get the {link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates. Returns: Roo.UpdateManager The UpdateManager	Roo.ContentPanel
	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
	isClosable () : Boolean Returns true is this panel was configured to be closable Returns true is this panel was configured to be closable Returns: Boolean	Roo.ContentPanel
	load (Object/String/Function *url, String/Object params, Function callback, Boolean discardUrl) : Roo.ContentPanel Loads this content panel immediately with content from XHR. Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {link* setUrl}. Parameters: Object/String/Function url 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. String/Object params (optional) The parameters to pass as either a URL encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2} Function callback (optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse) Boolean discardUrl (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: Roo.ContentPanel this	Roo.ContentPanel
	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
	refresh () Force a content refresh from the URL specified in the {link setUrl} method. Force a content refresh from the URL specified in the {link setUrl} method. Will fail silently if the {link setUrl} method has not been called. This does not activate the panel, just updates its content.	Roo.ContentPanel
	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
	setContent (String *content, Boolean loadScripts) Updates this panel's element Updates this panel's element Parameters: String content* The new content Boolean loadScripts (optional) true to look for and process scripts	Roo.ContentPanel
	setTitle (String *title) Set this panel's title Set this panel's title Parameters: String title*	Roo.ContentPanel
	setUrl (String/Function *url, String/Object params, Boolean loadOnce) : Roo.UpdateManager Set a URL to be used to load the content for this panel. 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: String/Function url* The URL to load the content from or a function to call to get the URL String/Object params (optional) The string params for the update call or an object of the params. See {link Roo.UpdateManagerupdate} for more details. (Defaults to null) Boolean loadOnce (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: Roo.UpdateManager The UpdateManager	Roo.ContentPanel
	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
	activate (Roo.ContentPanel *this) Fires when this panel is activated. Fires when this panel is activated. Parameters: Roo.ContentPanel this*	Roo.ContentPanel
	deactivate (Roo.ContentPanel *this) Fires when this panel is activated. Fires when this panel is activated. Parameters: Roo.ContentPanel this*	Roo.ContentPanel
	resize (Roo.ContentPanel *this, Number width, Number height) Fires when this panel is resized if fitToFrame is true. Fires when this panel is resized if fitToFrame is true. Parameters: Roo.ContentPanel this* Number width The width after any component adjustments Number height The height after any component adjustments	Roo.ContentPanel

Documentation generated by Introspection Doc Generator on Tue Jul 27 2010 11:05:06 GMT+0800 (HKT) Based on JsDoc Toolkit