Properties

Methods

Events

Config Options

Direct Link

Observable
  Controller

Class Ext.Controller

Package:	Ext
Defined In:	Controller.js
Class:	Controller
Extends:	Observable

Config Options

Config Options		Defined By
	listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. DOM events from ExtJs Components While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's `click` event passing the node clicked on. To access DOM events directly from a a child element of a Component, we need to specify this explicitly: `new Ext.Panel({ width: 400, height: 200, dockedItems: [{ xtype: 'toolbar' }], listeners: { click: { element: 'el', //bind to the underlying el property on the panel fn: function(){ console.log('click el'); } }, dblclick: { element: 'body', //bind to the underlying body property on the panel fn: function(){ console.log('dblclick body'); } } } });`	Observable

Public Properties

Property		Defined By
	renderTarget : Ext.Container The current {@link #setRenderTarget render target}. Read only	Controller

Public Methods

Method		Defined By
	Controller() Parameters: None. Returns: void	Controller
	addEvents( `Object\|String o`, `string Optional.` ) : void Adds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters: `o` : Object\|String Either an object with event names as properties with a value of `true` or the first event name string if multiple event names are being passed as separate parameters. `Optional.` : string Event name if multiple event names are being passed as separate parameters. Usage: `this.addEvents('storeloaded', 'storecleared');` Returns: void	Observable
	addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object. Appends an event handler to this object. Parameters: `eventName` : String The name of the event to listen for. `handler` : Function The method the event invokes. `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. properties. This may contain any of the following properties: scope : Object The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. delay : Number The number of milliseconds to delay the invocation of the handler after the 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 Ext.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. target : Observable Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable. element : String The element reference on the component to bind the event to. This is used to bind DOM events to underlying elements on Components. - This option is only valid for listeners bound to Components Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. `myPanel.on('hide', this.onClick, this, { single: true, delay: 100 });` 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. Returns: void	Observable
	addManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope`, `Object opt` ) : void Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed... Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. Parameters: `item` : Observable\|Element The item to which to add a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. `opt` : Object Optional. If the `ename` parameter was an event name, this is the addListener options. Returns: void	Observable
	build() : void Callback automatically tied to the index view's 'build' event. By default this just renders the registered 'build' vi... Callback automatically tied to the index view's 'build' event. By default this just renders the registered 'build' view Parameters: None. Returns: void	Controller
	clearListeners() : void Removes all listeners for this object including the managed listeners Removes all listeners for this object including the managed listeners Parameters: None. Returns: void	Observable
	clearManagedListeners() : void Removes all managed listeners for this object. Removes all managed listeners for this object. Parameters: None. Returns: void	Observable
	control() : void This function allows you to add listeners to a view in a convenient way This function allows you to add listeners to a view in a convenient way Parameters: None. Returns: void	Controller
	create( `Object data`, `Object options` ) : void Saves a phantom Model instance via its configured Proxy. Fires the 'instance-created' event if successful, the 'insta... Saves a phantom Model instance via its configured Proxy. Fires the 'instance-created' event if successful, the 'instance-creation-failed' event if not. Parameters: `data` : Object The data to create the instance from `options` : Object Optional options object containing callbacks for success and failure plus optional scope Returns: void	Controller
	destroy( `Ext.data.Model instance`, `Object options` ) : void Destroys one or more existing, previously saved model instances Destroys one or more existing, previously saved model instances Parameters: `instance` : Ext.data.Model The model instance to destroy `options` : Object success and failure callbacks Returns: void	Controller
	edit( `Ext.data.Model instance` ) : void Renders the edit form for a given model instance Renders the edit form for a given model instance Parameters: `instance` : Ext.data.Model The instance to edit Returns: void	Controller
	enableBubble( `String/Array events` ) : void Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if present. There is no implementation in the Observable base class. This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example: Ext.override(Ext.form.Field, { // Add functionality to Field's initComponent to enable the change event to bubble initComponent : Ext.createSequence(Ext.form.Field.prototype.initComponent, function() { this.enableBubble('change'); }), // We know that we want Field's events to bubble directly to the FormPanel. getBubbleTarget : function() { if (!this.formPanel) { this.formPanel = this.findParentByType('form'); } return this.formPanel; } }); var myForm = new Ext.formPanel({ title: 'User Details', items: [{ ... }], listeners: { change: function() { // Title goes red if form has been modified. myForm.header.setStyle('color', 'red'); } } }); Parameters: `events` : String/Array The event name to bubble, or an Array of event names. Returns: void	Observable
	fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters: `eventName` : String The name of the event to fire. `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.	Observable
	getBuildListeners() : Object Returns the listeners to attach to the view rendered by the build action. By default this returns listeners for save ... Returns the listeners to attach to the view rendered by the build action. By default this returns listeners for save and cancel, but this can be overridden Parameters: None. Returns: `Object` listeners	Controller
	getEditListeners() : Object Returns the listeners to attach to the view rendered by the edit action. By default this returns listeners for save a... Returns the listeners to attach to the view rendered by the edit action. By default this returns listeners for save and cancel, but this can be overridden Parameters: None. Returns: `Object` listeners	Controller
	getModel() : Ext.data.Model Returns the constructor for the model type linked to this controller Returns the constructor for the model type linked to this controller Parameters: None. Returns: `Ext.data.Model` The model constructor	Controller
	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: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false	Observable
	on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. Returns: void	Observable
	onCancelBuild( `Ext.Component view` ) : void Handler for the 'cancel' event fired by an build view. By default this just closes the view Handler for the 'cancel' event fired by an build view. By default this just closes the view Parameters: `view` : Ext.Component The build form Returns: void	Controller
	onCancelEdit( `Ext.Component view` ) : void Handler for the 'cancel' event fired by an edit view. By default this just closes the view Handler for the 'cancel' event fired by an edit view. By default this just closes the view Parameters: `view` : Ext.Component The edit form Returns: void	Controller
	onCreateInstance( `Ext.View view` ) : void Callback automatically tied to the index view's 'create' event. By default this just calls the controller's create fu... Callback automatically tied to the index view's 'create' event. By default this just calls the controller's create function with the data and some basic callbacks to handle errors or show success. Can be overridden to provide custom behavior Parameters: `view` : Ext.View The view instance that fired the event Returns: void	Controller
	onDestroyInstance( `Ext.data.Model instance`, `Ext.View view` ) : void Callback automatically tied to the index view's 'destroy' event. By default that just calls the controller's destroy ... Callback automatically tied to the index view's 'destroy' event. By default that just calls the controller's destroy function with the model instance and some basic callbacks to handle errors or show success. Can be overridden to provide custom behavior. Parameters: `instance` : Ext.data.Model The instance to destroy `view` : Ext.View The view instance that fired the event Returns: void	Controller
	onUpdateInstance( `Ext.Component view` ) : void Callback automatically tied to the index view's 'update' event. By default this just calls the controller's update fu... Callback automatically tied to the index view's 'update' event. By default this just calls the controller's update function with the data and some basic callbacks to handle errors or show success. Can be overridden to provide custom behavior Parameters: `view` : Ext.Component The view instance that fired the event Returns: void	Controller
	relayEvents( `Object o`, `Array events` ) : void Relays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by `this`. Parameters: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: void	Observable
	removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler. Removes an event handler. Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable
	removeManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope` ) : void Removes listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters: `item` : Observable\|Element The item from which to remove a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. Returns: void	Observable
	render( `String viewName`, `Object config` ) : Ext.View Renders a given view based on a registered name Renders a given view based on a registered name Parameters: `viewName` : String The name of the view to render `config` : Object Optional config object Returns: `Ext.View` The view instance	Controller
	resumeEvents() : void Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event... Resume firing events. (see suspendEvents) If events were suspended using the `queueSuspended` parameter, then all events fired during event suspension will be sent to any listeners now. Parameters: None. Returns: void	Observable
	setRenderTarget( `Ext.Container target` ) : void Sets the default container that components rendered using render will be added to. In many applications there is a fi... Sets the default container that components rendered using render will be added to. In many applications there is a fixed navigation panel and a content panel - the content panel would usually form the render target in this type of setup. Parameters: `target` : Ext.Container The container to add rendered components to Returns: void	Controller
	suspendEvents( `Boolean queueSuspended` ) : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: `queueSuspended` : Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events; Returns: void	Observable
	un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable
	update( `Ext.data.Model instance`, `Object updates`, `Object options` ) : void Updates an existing model instance by applying optional updates to it and attempting to save Updates an existing model instance by applying optional updates to it and attempting to save Parameters: `instance` : Ext.data.Model The existing instance `updates` : Object Optional additional updates to apply to the instance before saving `options` : Object success and failure callback functions Returns: void	Controller

Public Events

Event		Defined By
	instance-created : ( `Ext.data.Model instance` ) Fired when a new model instance has been successfully created by this controller Fired when a new model instance has been successfully created by this controller Listeners will be called with the following arguments: `instance` : Ext.data.Model The newly-created model instance	Controller
	instance-creation-failed : ( `Ext.data.Model instance`, `Object errors` ) Fired when an attempt at saving a new instance failed Fired when an attempt at saving a new instance failed Listeners will be called with the following arguments: `instance` : Ext.data.Model The instance that could not be saved `errors` : Object The set of errors (if any) that caused the failure	Controller
	instance-destroyed : ( `Ext.data.Model instance` ) Fired when an existing instance has been successfully destroyed by this controller Fired when an existing instance has been successfully destroyed by this controller Listeners will be called with the following arguments: `instance` : Ext.data.Model The instance that was destroyed	Controller
	instance-destruction-failed : ( `Ext.data.Model instance`, `Object errors` ) Fired when an existing instance could not be destroyed Fired when an existing instance could not be destroyed Listeners will be called with the following arguments: `instance` : Ext.data.Model The instance that could not be destroyed `errors` : Object The set of errors (if any) that caused the failure	Controller
	instance-update-failed : ( `Ext.data.Model instance`, `Object errors` ) Fired when an update to existing model instance could not be successfully completed Fired when an update to existing model instance could not be successfully completed Listeners will be called with the following arguments: `instance` : Ext.data.Model The instance that could not be updated `errors` : Object The set of errors (if any) that caused the failure	Controller
	instance-updated : ( `Ext.data.Model instance` ) Fired when an existing model instance has been successfully updated by this controller Fired when an existing model instance has been successfully updated by this controller Listeners will be called with the following arguments: `instance` : Ext.data.Model The instance that was updated	Controller