Properties Methods Events Config Options Direct Link

    Observable
      Component
        BoxComponent
          Toolbar
            StatusBar

# Class Ext.StatusBar

Package: | Ext
Defined In: | StatusBar.js
Class: | StatusBar
Extends: | Toolbar

Basic status bar component that can be used as the bottom toolbar of any Ext.Panel. In addition to supporting the standard Ext.Toolbar interface for adding buttons, menus and other items, the StatusBar provides a greedy status element that can be aligned to either side and has convenient methods for setting the status text and icon. You can also indicate that something is processing using the showBusy method.

Note: Although StatusBar supports xtype:'statusbar', at this time Ext.Toolbar (the base class) does not support xtype. For this reason, if you are adding Toolbar items into the StatusBar you must declare it using the "new StatusBar()" syntax for the items to render correctly.

    new Ext.Panel({
        title: 'StatusBar',
        // etc.
        bbar: new Ext.StatusBar({
            id: 'my-status',

            // defaults to use when the status is cleared:
            defaultText: 'Default status text',
            defaultIconCls: 'default-icon',

            // values to set initially:
            text: 'Ready',
            iconCls: 'ready-icon',

            // any standard Toolbar items:
            items: [{
                text: 'A Button'
            }, '-', 'Plain Text']
        })
    });

    // Update the status bar later in code:
    var sb = Ext.getCmp('my-status');
    sb.setStatus({
        text: 'OK',
        iconCls: 'ok-icon',
        clear: true // auto-clear after a set interval
    });

    // Set the status bar to show that something is processing:
    sb.showBusy();

    // processing....

    sb.clearStatus(); // once completeed

## Config Options

Config Options | Defined By
--- | ---
| allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component
| applyTo : Mixed The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ... The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container. | Component
| autoClear : Number The number of milliseconds to wait after setting the status via setStatus before automatically clearing the status te... The number of milliseconds to wait after setting the status via setStatus before automatically clearing the status text and icon (defaults to 5000). Note that this only applies when passing the `clear` argument to setStatus since that is the only way to defer clearing the status. This can be overridden by specifying a different `wait` value in setStatus. Calls to clearStatus always clear the status bar immediately and ignore this value. | StatusBar
| autoHeight : Boolean True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not ... True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not all will function as expected with a height of 'auto'. (defaults to false). | BoxComponent
| autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false). | Component
| autoWidth : Boolean True to use width:'auto', false to use fixed width. Note: although many components inherit this config option, not al... True to use width:'auto', false to use fixed width. Note: although many components inherit this config option, not all will function as expected with a width of 'auto'. (defaults to false). | BoxComponent
| busyIconCls : String The default iconCls applied when calling showBusy (defaults to 'x-status-busy'). It can be overridden at any time by ... The default iconCls applied when calling showBusy (defaults to 'x-status-busy'). It can be overridden at any time by passing the `iconCls` argument into `showBusy`. See the iconCls docs for additional details about customizing the icon. | StatusBar
| busyText : String The default text applied when calling showBusy (defaults to 'Loading...'). It can be overridden at any time by passin... The default text applied when calling showBusy (defaults to 'Loading...'). It can be overridden at any time by passing the `text` argument into `showBusy`. | StatusBar
| cls : String The base class applied to the containing element for this component on render (defaults to 'x-statusbar') | StatusBar
| ctCls : String An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for... An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules. | Component
| defaultIconCls : String The default iconCls value (see the iconCls docs for additional details about customizing the icon). This will be used... The default iconCls value (see the iconCls docs for additional details about customizing the icon). This will be used anytime the status bar is cleared with the `useDefaults:true` option (defaults to ''). | StatusBar
| defaultText : String The default text value. This will be used anytime the status bar is cleared with the useDefaults:true option (default... The default text value. This will be used anytime the status bar is cleared with the `useDefaults:true` option (defaults to ''). | StatusBar
| disabled : Boolean Render this component disabled (default is false). | Component
| disabledClass : String CSS class added to the component when it is disabled (defaults to "x-item-disabled"). | Component
| height : Number The height of this component in pixels (defaults to auto). | BoxComponent
| hidden : Boolean Render this component hidden (default is false). | Component
| hideMode : String How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi... How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". | Component
| hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide and show the... True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container. | Component
| iconCls : String A CSS class that will be applied to the status element and is expected to provide a background image that will serve ... A CSS class that will be applied to the status element and is expected to provide a background image that will serve as the status bar icon (defaults to ''). The class is applied directly to the div that also contains the status text, so the rule should provide the appropriate padding on the div to make room for the image. Example usage:
    // Example CSS rule:
    .x-statusbar .x-status-custom {
        padding-left: 25px;
        background: transparent url(images/custom-icon.gif) no-repeat 3px 3px;
    }

    // Initializing the status bar:
    var sb = new Ext.StatusBar({
        defaultIconCls: 'x-status-custom'
    });

    // Setting it in code:
    sb.setStatus({
        text: 'New status',
        iconCls: 'x-status-custom'
    });
| StatusBar
| id : String The unique id of this component (defaults to an auto-assigned id). | Component
| listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b... 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. | Observable
| overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized "active" or "hover" styles to the component or any of its children using standard CSS rules. | Component
| pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent
| pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent
| plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only requirement for a v... An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality. | Component
| renderTo : Mixed The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using... The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required. | Component
| stateEvents : Array An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be... An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). See stateful for an explanation of saving and restoring Component state. | Component
| stateId : String The unique id for this component to use for state management purposes (defaults to the component id). See stateful fo... The unique id for this component to use for state management purposes (defaults to the component id). See stateful for an explanation of saving and restoring Component state. | Component
| stateful : Boolean A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available. To set the state provider for the current page:
    Ext.state.Manager.setProvider(new Ext.state.CookieProvider());
Components attempt to save state when one of the events listed in the stateEvents configuration fires. You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events | Component
| statusAlign : String The alignment of the status element within the overall StatusBar layout. When the StatusBar is rendered, it creates a... The alignment of the status element within the overall StatusBar layout. When the StatusBar is rendered, it creates an internal div containing the status text and icon. Any additional Toolbar items added in the StatusBar's items config, or added via add or any of the supported add* methods, will be rendered, in added order, to the opposite side. The status element is greedy, so it will automatically expand to take up all sapce left over by any other items. Example usage:
    // Create a left-aligned status bar containing a button,
    // separator and text item that will be right-aligned (default):
    new Ext.Panel({
        title: 'StatusBar',
        // etc.
        bbar: new Ext.StatusBar({
            defaultText: 'Default status text',
            id: 'status-id',
            items: [{
                text: 'A Button'
            }, '-', 'Plain Text']
        })
    });

    // By adding the statusAlign config, this will create the
    // exact same toolbar, except the status and toolbar item
    // layout will be reversed from the previous example:
    new Ext.Panel({
        title: 'StatusBar',
        // etc.
        bbar: new Ext.StatusBar({
            defaultText: 'Default status text',
            id: 'status-id',
            statusAlign: 'right',
            items: [{
                text: 'A Button'
            }, '-', 'Plain Text']
        })
    });
| StatusBar
| style : String A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app... A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles. | Component
| text : String A string that will be rendered into the status element as the status message (defaults to ''); | StatusBar
| width : Number The width of this component in pixels (defaults to auto). | BoxComponent
| x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent
| xtype : String The registered xtype to create. This config option is not used when passing a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create. The predefined xtypes are listed here. If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr.registerType in order to be able to take advantage of lazy instantiation and rendering. | Component
| y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent

## Public Properties

Property | Defined By
--- | ---
| disabled : Boolean True if this component is disabled. Read-only. | Component
| hidden : Boolean True if this component is hidden. Read-only. | Component
| initialConfig : Object This Component's initial configuration specification. Read-only. | Component
| items : Ext.util.MixedCollection A MixedCollection of this Toolbar's items | Toolbar
| ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a container). Read-only. | Component
| rendered : Boolean True if this component has been rendered. Read-only. | Component

## Public Methods

Method | Defined By
--- | ---
| StatusBar( `Object/Array config` ) Creates a new StatusBar Creates a new StatusBar Parameters: `config` : Object/Array A config object Returns: `` | StatusBar
| add( `Mixed arg1`, `Mixed arg2`, `Mixed etc.` ) : void Adds element(s) to the toolbar -- this function takes a variable number of arguments of mixed type and adds them to t... Adds element(s) to the toolbar -- this function takes a variable number of arguments of mixed type and adds them to the toolbar. Parameters: `arg1` : Mixed The following types of arguments are all valid: Ext.Toolbar.Button config: A valid button config object (equivalent to addButton) HtmlElement: Any standard HTML element (equivalent to addElement) Field: Any form field (equivalent to addField) Item: Any subclass of Ext.Toolbar.Item (equivalent to addItem) String: Any generic string (gets wrapped in a Ext.Toolbar.TextItem, equivalent to addText). Note that there are a few special strings that are treated differently as explained next. 'separator' or '-': Creates a separator element (equivalent to addSeparator) ' ': Creates a spacer element (equivalent to addSpacer) '->': Creates a fill element (equivalent to addFill) `arg2` : Mixed `etc.` : Mixed Returns: `void` | Toolbar
| addButton( `Object/Array config` ) : Ext.Toolbar.Button/Array Adds a button (or buttons). See Ext.Toolbar.Button for more info on the config. Adds a button (or buttons). See Ext.Toolbar.Button for more info on the config. Parameters: `config` : Object/Array A button config or array of configs Returns: `Ext.Toolbar.Button/Array` | Toolbar
| addClass( `string cls` ) : void Adds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters: `cls` : string The CSS class name to add Returns: `void` | Component
| addDom( `Object config` ) : Ext.Toolbar.Item Adds a new element to the toolbar from the passed Ext.DomHelper config Adds a new element to the toolbar from the passed Ext.DomHelper config Parameters: `config` : Object Returns: `Ext.Toolbar.Item` The element's item | Toolbar
| addElement( `Mixed el` ) : Ext.Toolbar.Item Adds any standard HTML element to the toolbar Adds any standard HTML element to the toolbar Parameters: `el` : Mixed The element or id of the element to add Returns: `Ext.Toolbar.Item` The element's item | Toolbar
| addEvents( `Object object` ) : void Used to define events on this Observable Used to define events on this Observable Parameters: `object` : Object The object with the events defined Returns: `void` | Observable
| addField( `Ext.form.Field field` ) : Ext.Toolbar.Item Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have been rendered ... Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have been rendered yet. For a field that has already been rendered, use addElement. Parameters: `field` : Ext.form.Field Returns: `Ext.Toolbar.Item` | Toolbar
| addFill() : Ext.Toolbar.Fill Adds a fill element that forces subsequent additions to the right side of the toolbar Adds a fill element that forces subsequent additions to the right side of the toolbar Parameters: None. Returns: `Ext.Toolbar.Fill` The fill item | Toolbar
| addItem( `Ext.Toolbar.Item item` ) : Ext.Toolbar.Item Adds any Toolbar.Item or subclass Adds any Toolbar.Item or subclass Parameters: `item` : Ext.Toolbar.Item Returns: `Ext.Toolbar.Item` The item | Toolbar
- | addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this component Appends an event handler to this component Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (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 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. 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.
      foo.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:
      foo.on({
          'click' : this.onClick,
          'mouseover' : this.onMouseOver,
          'mouseout' : this.onMouseOut,
           scope: this
      });
Returns: `void` | Observable
| addSeparator() : Ext.Toolbar.Item Adds a separator Adds a separator Parameters: None. Returns: `Ext.Toolbar.Item` The separator item | Toolbar
| addSpacer() : Ext.Toolbar.Spacer Adds a spacer element Adds a spacer element Parameters: None. Returns: `Ext.Toolbar.Spacer` The spacer item | Toolbar
| addText( `String text` ) : Ext.Toolbar.Item Adds text to the toolbar Adds text to the toolbar Parameters: `text` : String The text to add Returns: `Ext.Toolbar.Item` The element's item | Toolbar
| applyToMarkup( `String/HTMLElement el` ) : void Apply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. Parameters: `el` : String/HTMLElement Returns: `void` | Component
| clearStatus( [`Object config`] ) : Ext.StatusBar Clears the status text and iconCls. Also supports clearing via an optional fade out animation. Clears the status text and iconCls. Also supports clearing via an optional fade out animation. Parameters: `config` : Object (optional) A config object containing any or all of the following properties. If this object is not specified the status will be cleared using the defaults below: `anim` {Boolean} : (optional) True to clear the status by fading out the status element (defaults to false which clears immediately). `useDefaults` {Boolean} : (optional) True to reset the text and icon using defaultText and defaultIconCls (defaults to false which sets the text to '' and removes any existing icon class). Returns: `Ext.StatusBar` this | StatusBar
| cloneConfig( `Object overrides` ) : Ext.Component Clone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. 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 | Component
| destroy() : void Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its Ext.Container (if applicable) and unregistering it from Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method should usually not need to be called directly. Parameters: None. Returns: `void` | Component
| disable() : Ext.Component Disable this component. Disable this component. Parameters: None. Returns: `Ext.Component` this | Component
| enable() : Ext.Component Enable this component. Enable this component. Parameters: None. Returns: `Ext.Component` this | Component
| findParentBy( `Function fcn`, [`Object scope`] ) : Array Find a container above this component at any level by a custom function. If the passed function returns true, the con... Find a container above this component at any level by a custom function. If the passed function returns true, the container will be returned. The passed function is called with the arguments (container, this component). Parameters: `fcn` : Function `scope` : Object (optional) Returns: `Array` Array of Ext.Components | Component
| findParentByType( `String/Class xtype` ) : Container Find a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters: `xtype` : String/Class The xtype string for a component, or the class of the component directly Returns: `Container` The found container | Component
| 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: `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 | Observable
| focus( [`Boolean selectText`], [`Boolean/Number delay`] ) : Ext.Component Try to focus this component. Try to focus this component. 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 | Component
| getBox( [`Boolean local`] ) : Object Gets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. 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} | BoxComponent
| getEl() : Ext.Element Returns the underlying Ext.Element. Returns the underlying Ext.Element. Parameters: None. Returns: `Ext.Element` The element | Component
| getId() : String Returns the id of this component. Returns the id of this component. Parameters: None. Returns: `String` | Component
| getItemId() : String Returns the item id of this component. Returns the item id of this component. Parameters: None. Returns: `String` | Component
| getPosition( [`Boolean local`] ) : Array Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. 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]) | BoxComponent
| getSize() : Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters: None. Returns: `Object` An object containing the element's size {width: (element width), height: (element height)} | BoxComponent
| getText() : String Returns the current status text. Returns the current status text. Parameters: None. Returns: `String` The status text | StatusBar
| getXType() : String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ext.Component header. Example usage:
    var t = new Ext.form.TextField();
    alert(t.getXType());  // alerts 'textfield'
Parameters: None. Returns: `String` The xtype | Component
| getXTypes() : String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext... 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.TextField();
    alert(t.getXTypes());  // alerts 'component/box/field/textfield'
Parameters: None. Returns: `String` The xtype hierarchy string | Component
| 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
| hide() : Ext.Component Hide this component. Hide this component. Parameters: None. Returns: `Ext.Component` this | Component
| insertButton( `Number index`, `Object/Ext.Toolbar.Item/Ext.Toolbar.Button/Array item` ) : Ext.Toolbar.Button/Item Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index. Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index. Parameters: `index` : Number The index where the item is to be inserted `item` : Object/Ext.Toolbar.Item/Ext.Toolbar.Button/Array The button, or button config object to be inserted, or an array of buttons/configs. Returns: `Ext.Toolbar.Button/Item` | Toolbar
| isVisible() : void Returns true if this component is visible. Returns true if this component is visible. Parameters: None. Returns: `void` | Component
| isXType( `String xtype`, [`Boolean shallow`] ) : void Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from th... 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.TextField();
    var isText = t.isXType('textfield');        // true
    var isBoxSubclass = t.isXType('box');       // true, descended from BoxComponent
    var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent 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: `void` | Component
| on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this element (shorthand for addListener) 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 `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) Returns: `void` | Observable
| purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters: None. Returns: `void` | Observable
| 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
| removeClass( `string cls` ) : void Removes a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters: `cls` : string The CSS class name to remove Returns: `void` | Component
| removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener 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` | Observable
| render( [`Element/HTMLElement/String container`], [`String/Number position`] ) : void Render this Components into the passed HTML element. If you are using a Container object to house this Component, the... Render this Components into the passed HTML element. If you are using a Container object to house this Component, then do not use the render method. A Container's child Components are rendered by that Container's layout manager when the Container is first rendered. Certain layout managers allow dynamic addition of child components. Those that do include Ext.layout.CardLayout, Ext.layout.AnchorLayout, Ext.layout.FormLayout, Ext.layout.TableLayout. If the Container is already rendered when a new child Component is added, you may need to call the Container's 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. When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must configure the Container with a layout manager which creates and manages the type of layout you have in mind. Omitting the Container's layout config means that a basic layout manager is used which does nothnig but render child components sequentially into the Container. No sizing or positioning will be performed in this situation. Parameters: `container` : Element/HTMLElement/String (optional) The element this Component should be rendered into. If it is being created from existing markup, this should be omitted. `position` : String/Number (optional) The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) Returns: `void` | Component
| resumeEvents() : void Resume firing events. (see suspendEvents) Resume firing events. (see suspendEvents) Parameters: None. Returns: `void` | Observable
| setDisabled( `Boolean disabled` ) : void Convenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters: `disabled` : Boolean Returns: `void` | Component
| setHeight( `Number height` ) : Ext.BoxComponent Sets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters: `height` : Number The new height to set Returns: `Ext.BoxComponent` this | BoxComponent
| setIcon( [`String iconCls`] ) : Ext.StatusBar Convenience method for setting the status icon directly. For more flexible options see setStatus. See iconCls for co... Convenience method for setting the status icon directly. For more flexible options see setStatus. See iconCls for complete details about customizing the icon. Parameters: `iconCls` : String (optional) The icon class to set (defaults to '', and any current icon class is removed) Returns: `Ext.StatusBar` this | StatusBar
| setPagePosition( `Number x`, `Number y` ) : Ext.BoxComponent Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the move event. Parameters: `x` : Number The new x position `y` : Number The new y position Returns: `Ext.BoxComponent` this | BoxComponent
| setPosition( `Number left`, `Number top` ) : Ext.BoxComponent Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires the move event. Parameters: `left` : Number The new left `top` : Number The new top Returns: `Ext.BoxComponent` this | BoxComponent
| setSize( `Number/Object width`, `Number height` ) : Ext.BoxComponent Sets the width and height of the component. This method fires the resize event. This method can accept either width... Sets the width and height of the component. This method fires the resize event. This method can accept either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. Parameters: `width` : Number/Object The new width to set, or a size object in the format {width, height} `height` : Number The new height to set (not required if a size object is passed as the first arg) Returns: `Ext.BoxComponent` this | BoxComponent
- | setStatus( [`Object/String config`] ) : Ext.StatusBar Sets the status text and/or iconCls. Also supports automatically clearing the status that was set after a specified ... Sets the status text and/or iconCls. Also supports automatically clearing the status that was set after a specified interval. Parameters: `config` : Object/String A config object specifying what status to set, or a string assumed to be the status text (and all other options are defaulted as explained below). A config object containing any or all of the following properties can be passed: `text` {String} : (optional) The status text to display. If not specified, any current status text will remain unchanged. `iconCls` {String} : (optional) The CSS class used to customize the status icon (see iconCls for details). If not specified, any current iconCls will remain unchanged. `clear` {Boolean/Number/Object} : (optional) Allows you to set an internal callback that will automatically clear the status text and iconCls after a specified amount of time has passed. If clear is not specified, the new status will not be auto-cleared and will stay until updated again or cleared using clearStatus. If `true` is passed, the status will be cleared using autoClear, defaultText and defaultIconCls via a fade out animation. If a numeric value is passed, it will be used as the callback interval (in milliseconds), overriding the autoClear value. All other options will be defaulted as with the boolean option. To customize any other options, you can pass an object in the format: `wait` {Number} : (optional) The number of milliseconds to wait before clearing (defaults to autoClear). `anim` {Number} : (optional) False to clear the status immediately once the callback executes (defaults to true which fades the status out). `useDefaults` {Number} : (optional) False to completely clear the status text and iconCls (defaults to true which uses defaultText and defaultIconCls). Example usage:
      // Simple call to update the text
      statusBar.setStatus('New status');

      // Set the status and icon, auto-clearing with default options:
      statusBar.setStatus({
          text: 'New status',
          iconCls: 'x-status-custom',
          clear: true
      });

      // Auto-clear with custom options:
      statusBar.setStatus({
          text: 'New status',
          iconCls: 'x-status-custom',
          clear: {
              wait: 8000,
              anim: false,
              useDefaults: false
          }
      });
Returns: `Ext.StatusBar` this | StatusBar
| setText( [`String text`] ) : Ext.StatusBar Convenience method for setting the status text directly. For more flexible options see setStatus. Convenience method for setting the status text directly. For more flexible options see setStatus. Parameters: `text` : String (optional) The text to set (defaults to '') Returns: `Ext.StatusBar` this | StatusBar
| setVisible( `Boolean visible` ) : Ext.Component Convenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters: `visible` : Boolean True to show, false to hide Returns: `Ext.Component` this | Component
| setWidth( `Number width` ) : Ext.BoxComponent Sets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters: `width` : Number The new width to set Returns: `Ext.BoxComponent` this | BoxComponent
| show() : Ext.Component Show this component. Show this component. Parameters: None. Returns: `Ext.Component` this | Component
| showBusy( [`Object/String config`] ) : Ext.StatusBar Convenience method for setting the status text and icon to special values that are pre-configured to indicate a "busy... Convenience method for setting the status text and icon to special values that are pre-configured to indicate a "busy" state, usually for loading or processing activities. Parameters: `config` : Object/String (optional) A config object in the same format supported by setStatus, or a string to use as the status text (in which case all other options for setStatus will be defaulted). Use the `text` and/or `iconCls` properties on the config to override the default busyText and busyIconCls settings. If the config argument is not specified, busyText and busyIconCls will be used in conjunction with all of the default options for setStatus. Returns: `Ext.StatusBar` this | StatusBar
| suspendEvents() : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: None. Returns: `void` | Observable
| syncSize() : Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters: None. Returns: `Ext.BoxComponent` this | BoxComponent
| un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener (shorthand for removeListener) 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` | Observable
| updateBox( `Object box` ) : Ext.BoxComponent Sets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters: `box` : Object An object in the format {x, y, width, height} Returns: `Ext.BoxComponent` this | BoxComponent

## Public Events

Event | Defined By
--- | ---
| beforedestroy : ( `Ext.Component this` ) Fires before the component is destroyed. Return false to stop the destroy. Fires before the component is destroyed. Return false to stop the destroy. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforehide : ( `Ext.Component this` ) Fires before the component is hidden. Return false to stop the hide. Fires before the component is hidden. Return false to stop the hide. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforerender : ( `Ext.Component this` ) Fires before the component is rendered. Return false to stop the render. Fires before the component is rendered. Return false to stop the render. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforeshow : ( `Ext.Component this` ) Fires before the component is shown. Return false to stop the show. Fires before the component is shown. Return false to stop the show. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforestaterestore : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is restored. Return false to stop the restore. Fires before the state of the component is restored. Return false to stop the restore. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component
| beforestatesave : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component
| destroy : ( `Ext.Component this` ) Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| disable : ( `Ext.Component this` ) Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| enable : ( `Ext.Component this` ) Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| hide : ( `Ext.Component this` ) Fires after the component is hidden. Fires after the component is hidden. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| move : ( `Ext.Component this`, `Number x`, `Number y` ) Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments: `this` : Ext.Component `x` : Number The new x position `y` : Number The new y position | BoxComponent
| render : ( `Ext.Component this` ) Fires after the component is rendered. Fires after the component is rendered. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| resize : ( `Ext.Component this`, `Number adjWidth`, `Number adjHeight`, `Number rawWidth`, `Number rawHeight` ) Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments: `this` : Ext.Component `adjWidth` : Number The box-adjusted width that was set `adjHeight` : Number The box-adjusted height that was set `rawWidth` : Number The width that was originally specified `rawHeight` : Number The height that was originally specified | BoxComponent
| show : ( `Ext.Component this` ) Fires after the component is shown. Fires after the component is shown. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| staterestore : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component
| statesave : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component