Parameters

• o : Observable
  The Observable to capture events from.
• fn : Function
  The function to call when an event is fired.
• scope : Object
  (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

• Void

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
    console.log('Ajax request made to ' + options.url);
});

Parameters

• c : Function

  The class constructor to make observable.

• listeners : Object

  An object containing a series of listeners to add. See addListener.

Returns

• Void

Parameters

• o : Observable
  The Observable to release

Returns

• Void

Adds Component(s) to this Container.

Description:

• Fires the beforeadd event before adding.
• The Container's default config values will be applied accordingly (see defaults for details).
• Fires the add event after the component has been added.

Notes:

If the Container is already rendered when add is called, you may need to call doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once. For example:

r tb = new Ext.toolbar.Toolbar();
.render(document.body);  // toolbar is rendered
.add({text:'Button 1'}); // add multiple items (defaultType for Toolbar is 'button')
.add({text:'Button 2'});

Warning:

Containers directly managed by the BorderLayout layout manager may not be removed or added. See the Notes for BorderLayout for more details.

Parameters

• component : ...Object/Array

  Either one or more Components to add or an Array of Components to add. See items for additional information.

Returns

• Ext.Component/Array   The Components that were added.

Returns

• Void

Parameters

• component. : Object/Array
  The Component or array of components to add. The components must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left').
• pos : Number
  (optional) The index at which the Component will be added

Returns

• Void

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

Parameters

• eventName : String
  The name of the event to listen for. May also be an object who's property names are event names. See
• 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
    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

    new Ext.panel.Panel({
        title: 'The title',
        listeners: {
            click: this.handlePanelClick,
            element: 'body'
        }
    });

    When added in this way, the options available are the options applicable to Ext.core.Element-addListener

  
  

  Combining Options
  Using the options argument, it is possible to combine different types of listeners:
  
  A delayed, one-time listener.

  myPanel.on('hide', this.handleClick, 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 events. For example:

  myGridPanel.on({
      cellClick: this.onCellClick,
      mouseover: this.onMouseOver,
      mouseout: this.onMouseOut,
      scope: this // Important. Ensure "this" is correct during handler execution
  });

  .

Returns

• Void

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

Parameters

• this : Ext.Component
• adjWidth : Number
  The box-adjusted width that was set
• adjHeight : Number
  The box-adjusted height that was set

Returns

• Void

Parameters

• element : Mixed
  The element to align to.
• position : String
  (optional, defaults to "tl-bl?") The position to align to (see Ext.core.Element-alignTo for more details).
• offsets : Array
  (optional) Offset the positioning by [x, y]

Returns

• Component   this

Parameters

• animObj : Ext.fx.Anim
  An Ext.fx Anim object

Returns

• Ext.core.Element   this

Parameters

• fn : Function
  The function to call
• scope : Object
  (optional) The scope of the function (defaults to current node)
• args : Array
  (optional) The args to call the function with (default to passing the current component)

Returns

• Ext.Component   this

Returns

• Component   this

Parameters

• selector : String
  An Ext.ComponentQuery selector

Returns

• Ext.Component

Returns

• Void

Returns

• Void

Parameters

• overrides : Object
  A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates.

Returns

• Ext.Component   clone The cloned copy of this component

Closes the Panel. By default, this method, removes it from the DOM, destroys the Panel object and all its descendant Components. The beforeclose event is fired before the close happens and will cancel the close action if it returns false.

Note: This method is not affected by the closeAction setting which only affects the action triggered when clicking the 'close' tool in the header. To hide the Panel without destroying it, call hide.

Returns

• Void

Parameters

• direction. : Number
  The direction to collapse towards. Must be one of

  • Ext.Component.DIRECTION_TOP
  • Ext.Component.DIRECTION_RIGHT
  • Ext.Component.DIRECTION_BOTTOM
  • Ext.Component.DIRECTION_LEFT
• animate : Boolean
  True to animate the transition, else false (defaults to the value of the animCollapse panel config)

Returns

• Ext.panel.Panel   this

Parameters

• : config

Returns

• Void

Returns

• Void

Returns

• Void

Returns

• Ext.container.Container   this

Moves this floating Component into a constrain region.

By default, this Component is constrained to be within the container it was added to, or the element it was rendered to.

An alternative constraint may be passed.

Parameters

• constrainTo : Mixed
  Optional. The Element or Region into which this Component is to be constrained.

Returns

• Void

Parameters

• selector : String
  An Ext.ComponentQuery selector

Returns

• Ext.Component

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.Function.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

Parameters

• animate : Boolean
  True to animate the transition, else false (defaults to the value of the animCollapse panel config)

Returns

• Ext.panel.Panel   this

This method finds the topmost active layout who's processing will eventually determine the size and position of this Component.

This method is useful when dynamically adding Components into Containers, and some processing must take place after the final sizing and positioning of the Component has been performed.

Returns

• Void

Parameters

• fn : Function
  The custom function to call with the arguments (container, this component).

Returns

• Ext.container.Container   The first Container for which the custom function returns true

Find a container above this component at any level by xtype or class

See also the up method.

Parameters

• xtype : String/Class
  The xtype string for a component, or the class of the component directly

Returns

• Ext.container.Container   The first Container which matches the given xtype or class

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.

Parameters

• selectText : Boolean
  (optional) If applicable, true to also select the text in this component
• delay : Boolean/Number
  (optional) Delay the focus this number of milliseconds (true for 10 milliseconds).

Returns

• Ext.Component   this

Parameters

• local : Boolean
  (optional) If true the element's left and top are returned instead of page XY (defaults to false)

Returns

• Object   box An object in the format {x, y, width, height}

Returns

• Ext.container.Container   the Container which owns this Component.

Parameters

• The : el
  element to test.

Returns

• Component   The child item which contains the passed element.

Parameters

• comp : String/Number
  The id, itemId or position of the docked component (see getComponent for details)

Returns

• Ext.Component   The docked component (if found)

Parameters

• cqSelector : String
  A ComponentQuery selector string to filter the returned items.

Returns

• Array   An array of components.

Returns

• Void

Returns

• Number

Returns

• Void

Parameters

• position : String/Number/Element/HTMLElement
  Index, element id or element you want to put this component before.

Returns

• HTMLElement   DOM element that you can use in the insertBefore

Returns

• Void

Parameters

• local : Boolean
  (optional) If true the element's left and top are returned instead of page XY (defaults to false)

Returns

• Array   The XY position of the element (e.g., [100, 200])

Returns

• Object   An object containing the element's size {width: (element width), height: (element height)}

Returns

• Number

var t = new Ext.form.Text();
alert(t.getXType());  // alerts 'textfield'

Returns

• String   The xtype

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header.

If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

Example usage:

var t = new Ext.form.Text();
alert(t.getXTypes());  // alerts 'component/field/textfield'

Returns

• String   The xtype hierarchy string

Returns

• Mixed   anim if element has active effects, else false

Parameters

• eventName : String
  The name of the event to check for

Returns

• Boolean   True if the event is being listened for, else false

Parameters

• pos : Number
  The index at which the Component will be inserted
• component. : Object/Array
  The Component or array of components to add. The components must include a 'dock' paramater on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left').

Returns

• Void

Returns

• Boolean   the disabled state of this Component.

Returns

• Boolean   the draggable state of this component.

Returns

• Boolean   the droppable state of this component.

Returns

• Boolean   the floating state of this component.

Returns

• Boolean   the hidden state of this Component.

Parameters

• deep. : Boolean

  Optional. Pass true to interrogate the visibility status of all parent Containers to determine whether this Component is truly visible to the user.

  Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating dynamically laid out UIs in a hidden Container before showing them.

Returns

• Boolean   True if this component is visible, false otherwise.

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true).

If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

For a list of all available xtypes, see the Ext.Component header.

Example usage:

var t = new Ext.form.Text();
var isText = t.isXType('textfield');        // true
var isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.Field
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.Field instance

Parameters

• xtype : String
  The xtype to check for this Component
• shallow : Boolean
  (optional) False to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype.

Returns

• Boolean   True if this component descends from the specified xtype, false otherwise.

Parameters

• fromIdx : Number
  The index the Component you wish to move is currently at.
• toIdx : Number
  The new index for the Component.

Returns

• Ext.Component   component The Component (or config object) that was moved.

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed ComponentQuery selector.

May also be refered to as prev()

Parameters

• Optional. : selector
  A ComponentQuery selector to filter the following items.

Returns

• Void

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

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed ComponentQuery selector.

May also be refered to as prev()

Parameters

• Optional. : selector
  A ComponentQuery selector to filter the preceding items.

Returns

• Void

Parameters

• selector : String
  Selector complying to an Ext.ComponentQuery selector

Returns

• Array   Ext.Component's which matched the selector

Parameters

• origin : Object
  The Observable whose events this object is to relay.
• events : Array
  Array of event names to relay.

Returns

• Void

Returns

• Void

Parameters

• item. : Ext.Component
  The Component to remove.
• autoDestroy : Boolean
  (optional) Destroy the component after removal.

Returns

• Void

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

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

Returns

• Void

Returns

• Ext.core.Element   The Element

Parameters

• active : Boolean
  True to activate the Component, false to deactivate it (defaults to false)

Returns

• Void

Parameters

• scroll : Boolean
  True to allow the Component to auto scroll.

Returns

• Ext.Component   this

Returns

• Component   this

Parameters

• height : Number
  The new height to set. This may be one of:

  • A Number specifying the new height in the Element's Ext.core.Element-defaultUnits (by default, pixels).
  • A String used to set the CSS height style.
  • undefined to leave the height unchanged.

Returns

• Ext.Component   this

Parameters

• : cls

Returns

• Void

Parameters

• load : Boolean/Object
  True to show the default LoadMask or a config object that will be passed to the LoadMask constructor. False to hide the current LoadMask.
• targetEl : Boolean
  True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)

Returns

• Ext.LoadMask   The LoadMask instance that has just been shown.

Parameters

• x : Number
  The new x position
• y : Number
  The new y position
• animate : Mixed
  If passed, the Component is animated into its new position. If this parameter is a number, it is used as the animation duration in milliseconds.

Returns

• Ext.Component   this

Parameters

• left : Number
  The new left
• top : Number
  The new top
• animate : Mixed
  If true, the Component is animated into its new position. You may also pass an animation configuration.

Returns

• Ext.Component   this

Parameters

• width : Mixed
  The new width to set. This may be one of:

  • A Number specifying the new width in the Element's Ext.core.Element-defaultUnits (by default, pixels).
  • A String used to set the CSS width style.
  • A size object in the format {width: widthValue, height: heightValue}.
  • undefined to leave the width unchanged.
• height : Mixed
  The new height to set (not required if a size object is passed as the first arg). This may be one of:

  • A Number specifying the new height in the Element's Ext.core.Element-defaultUnits (by default, pixels).
  • A String used to set the CSS height style. Animation may not be used.
  • undefined to leave the height unchanged.

Returns

• Ext.Component   this

Parameters

• title : String

Returns

• Void

Parameters

• visible : Boolean
  True to show, false to hide

Returns

• Ext.Component   this

Parameters

• width : Number
  The new width to setThis may be one of:

  • A Number specifying the new width in the Element's Ext.core.Element-defaultUnits (by default, pixels).
  • A String used to set the CSS width style.

Returns

• Ext.Component   this

Shows this Component, rendering it first if Ext.Component-autoRender is true.

For a Window, it activates it and brings it to front if hidden.

Parameters

• animateTarget : String/Element
  (optional) The target element or id from which the Component should animate while opening (defaults to null with no animation)
• callback : Function
  (optional) A callback function to call after the window is displayed. Only necessary if animation was specified.
• scope : Object
  (optional) The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns

• Component   this

Returns

• Ext.core.Element   The Element

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

Returns

• Ext.core.Element   The Element

Returns

• Component   this

Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

Parameters

• preventFocus : Boolean
  (optional) Specify true to prevent the Component from being focused.

Returns

• Component   this

Returns

• Ext.panel.Panel   this

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

Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.

Example:

var owningTabContainer = grid.up('tabcontainer');

Parameters

• selector : String
  Optional. The simple selector to test.

Returns

• Ext.container.Container   The matching ancestor Container (or undefined if no match was found).

Parameters

• htmlOrData : Mixed
  If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.core.Element update
• loadScripts : Boolean
  (optional) Only legitimate when using the html configuration. Defaults to false
• callback : Function
  (optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading

Returns

• Void

Parameters

• box : Object
  An object in the format {x, y, width, height}

Returns

• Ext.Component   this