Touch 1.1.1 Sencha Docs

Ext.NestedList

Hierarchy

Files

NestedList provides a miller column interface to navigate between nested sets and provide a clean interface with limited screen real-estate.

// store with data
var data = {
    text: 'Groceries',
    items: [{
        text: 'Drinks',
        items: [{
            text: 'Water',
            items: [{
                text: 'Sparkling',
                leaf: true
            },{
                text: 'Still',
                leaf: true
            }]
        },{
            text: 'Coffee',
            leaf: true
        },{
            text: 'Espresso',
            leaf: true
        },{
            text: 'Redbull',
            leaf: true
        },{
            text: 'Coke',
            leaf: true
        },{
            text: 'Diet Coke',
            leaf: true
        }]
    },{
        text: 'Fruit',
        items: [{
            text: 'Bananas',
            leaf: true
        },{
            text: 'Lemon',
            leaf: true
        }]
    },{
        text: 'Snacks',
        items: [{
            text: 'Nuts',
            leaf: true
        },{
            text: 'Pretzels',
            leaf: true
        },{
            text: 'Wasabi Peas',
            leaf: true
        }]
    },{
        text: 'Empty Category',
        items: []
    }]
};
Ext.regModel('ListItem', {
    fields: [{name: 'text', type: 'string'}]
});
var store = new Ext.data.TreeStore({
    model: 'ListItem',
    root: data,
    proxy: {
        type: 'ajax',
        reader: {
            type: 'tree',
            root: 'items'
        }
    }
});
var nestedList = new Ext.NestedList({
    fullscreen: true,
    title: 'Groceries',
    displayField: 'text',
    store: store
});

Using a Detail Card

Often it is useful to show a "details" card for each node - this is a card generated at runtime which is displayed when the user taps on a leaf node. Here's how we can do this (using the same store as above):

new Ext.NestedList({
    fullscreen: true,
    title: 'Groceries',
    displayField: 'text',
    store: store,

    getDetailCard: function(recordNode, parentNode) {
        return new Ext.Panel({
            title: 'Details about ' + recordNode.text,
            html: recordNode.text + ' is great'
        });
    }
});

Available since: 1.1.0

Defined By

Config options

A string component id or the numeric index of the component that should be initially activated within the container's...

A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.CardLayout and Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem.

Available since: 1.1.0

Ext.NestedList
view source
: Boolean
Set to true to alow the user to deselect leaf items via interaction. ...

Set to true to alow the user to deselect leaf items via interaction. Defaults to false.

Defaults to: false

Available since: 1.1.0

If true the container will automatically destroy any contained component that is removed from it, else destruction mu...

If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually (defaults to true).

Defaults to: true

Available since: 1.1.0

Ext.NestedList
view source
: String
The label to display for the back button. ...

The label to display for the back button. Defaults to "Back".

Defaults to: 'Back'

Available since: 1.1.0

The base CSS class to apply to this panel's element (defaults to 'x-panel'). ...

The base CSS class to apply to this panel's element (defaults to 'x-panel').

Defaults to: 'x-panel'

Available since: 1.1.0

Overrides: Ext.lib.Container.baseCls, Ext.lib.Panel.baseCls

A shortcut for setting a border style on the body element. ...

A shortcut for setting a border style on the body element. The value can either be a number to be applied to all sides, or a normal css string describing borders. Defaults to undefined.

Available since: 1.1.0

A shortcut for setting a margin style on the body element. ...

A shortcut for setting a margin style on the body element. The value can either be a number to be applied to all sides, or a normal css string describing margins. Defaults to undefined.

Available since: 1.1.0

A shortcut for setting a padding style on the body element. ...

A shortcut for setting a padding style on the body element. The value can either be a number to be applied to all sides, or a normal css string describing padding. Defaults to undefined.

Available since: 1.1.0

Specifies the border for this component. ...

Specifies the border for this component. The border can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

Available since: 1.1.0

An array of events that, when fired, should be bubbled to any parent container. ...

An array of events that, when fired, should be bubbled to any parent container. See Ext.util.Observable.enableBubble. Defaults to ['add', 'remove'].

Defaults to: ['add', 'remove']

Available since: 1.1.0

Ext.NestedList
view source
: String
Animation to be used during transitions of cards. ...

Animation to be used during transitions of cards. Any valid value from Ext.anims can be used ('fade', 'slide', 'flip', 'cube', 'pop', 'wipe'). Defaults to 'slide'.

Defaults to: 'slide'

Available since: 1.1.0

Overrides: Ext.Container.cardSwitchAnimation

Center the Component. ...

Center the Component. Defaults to false.

Defaults to: false

Available since: 1.1.0

Ext.NestedList
view source
: Boolean/Number
Number of milliseconds to show the highlight when going back in a list. ...

Number of milliseconds to show the highlight when going back in a list. (Defaults to 200). Passing false will keep the prior list selection.

Defaults to: 200

Available since: 1.1.0

An optional extra CSS class that will be added to this component's Element (defaults to ''). ...

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

Available since: 1.1.0

Ext.NestedList
view source
: String
CSS Class to be added to a components root level element to give distinction to it via styling. ...

CSS Class to be added to a components root level element to give distinction to it via styling.

Defaults to: 'x-nested-list'

Available since: 1.1.0

Overrides: Ext.lib.Component.componentCls

The sizing and positioning of the component Elements is the responsibility of the Component's layout manager which ...

The sizing and positioning of the component Elements is the responsibility of

the Component's layout manager which creates and manages the type of layout specific to the component.

If the layout configuration is not explicitly specified for a general purpose compopnent the default layout manager will be used.

Defaults to: 'dock'

Available since: 1.1.0

Overrides: Ext.lib.Component.componentLayout

Optional. ...

Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content for this component.

  • Description :
    This config option is used to take an existing HTML element and place it in the layout element of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
  • Notes :
    The specified HTML element is appended to the layout element of the component after any configured HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
    The specified HTML element used will not participate in any layout scheme that the Component may use. It is just HTML. Layouts operate on child items.
    Add either the x-hidden or the x-hide-display CSS class to prevent a brief flicker of the content before it is rendered to the panel.

Available since: 1.1.0

The initial set of data to apply to the tpl to update the content area of the Component.

The initial set of data to apply to the tpl to update the content area of the Component.

Available since: 1.1.0

This option is a means of applying default settings to all added items whether added through the items config or via ...

This option is a means of applying default settings to all added items whether added through the items config or via the add or insert methods.

If an added item is a config object, and not an instantiated Component, then the default properties are unconditionally applied. If the added item is an instantiated Component, then the default properties are applied conditionally so as not to override existing properties in the item.

If the defaults option is specified as a function, then the function will be called using this Container as the scope (this reference) and passing the added item as the first parameter. Any resulting object from that call is then applied to the item as default properties.

For example, to automatically apply padding to the body of each of a set of contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.

Usage:

defaults: {               // defaults are applied to items, not the container
    autoScroll:true
},
items: [
    {
        xtype: 'panel',   // defaults do not have precedence over
        id: 'panel1',     // options in config objects, so the defaults
        autoScroll: false // will not be applied here, panel1 will be autoScroll:false
    },
    new Ext.Panel({       // defaults do have precedence over options
        id: 'panel2',     // options in components, so the defaults
        autoScroll: false // will be applied here, panel2 will be autoScroll:true.
    })
]
       

Available since: 1.1.0

Defaults to false. ...

Defaults to false.

Defaults to: false

Available since: 1.1.0

CSS class to add when the Component is disabled. ...

CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.

Defaults to: 'x-item-disabled'

Available since: 1.1.0

Ext.NestedList
view source
: String
Display field to use when setting item text and title. ...

Display field to use when setting item text and title. This configuration is ignored when overriding getItemTextTpl or getTitleTextTpl for the item text or title. (Defaults to 'text')

Defaults to: 'text'

Available since: 1.1.0

A component or series of components to be added as docked items to this panel. ...

A component or series of components to be added as docked items to this panel. The docked items can be docked to either the top, right, left or bottom of a panel. This is typically used for things like toolbars or tab bars:

var panel = new Ext.Panel({
    fullscreen: true,
    dockedItems: [{
        xtype: 'toolbar',
        dock: 'top',
        items: [{
            text: 'Docked to the bottom'
        }]
    }]
});

Available since: 1.1.0

Allows the component to be dragged via the touch event.

Allows the component to be dragged via the touch event.

Available since: 1.1.0

Ext.NestedList
view source
: String
Empty text to display when a subtree is empty. ...

Empty text to display when a subtree is empty.

Defaults to: 'No items available.'

Available since: 1.1.0

Create the Component as a floating and use absolute positioning. ...

Create the Component as a floating and use absolute positioning. Defaults to false.

Defaults to: false

Available since: 1.1.0

The class that is being added to this component when its floating. ...

The class that is being added to this component when its floating. (defaults to x-floating)

Defaults to: 'x-floating'

Available since: 1.1.0

Force the component to take up 100% width and height available. ...

Force the component to take up 100% width and height available. Defaults to false. Setting this configuration immediately sets the monitorOrientation config to true. Setting this to true will render the component instantly.

Defaults to: false

Available since: 1.1.0

The height of this component in pixels.

The height of this component in pixels.

Available since: 1.1.0

Defaults to false. ...

Defaults to false.

Defaults to: false

Available since: 1.1.0

True to automatically bind a tap listener to the mask that hides the window. ...

True to automatically bind a tap listener to the mask that hides the window. Defaults to true. Note: if you set this property to false you have to programmaticaly hide the overlay.

Defaults to: true

Available since: 1.1.0

An HTML fragment, or a DomHelper specification to use as the layout element content (defaults to ''). ...

An HTML fragment, or a DomHelper specification to use as the layout element content (defaults to ''). The HTML content is added after the component is rendered, so the document will not contain this HTML at the time the render event is fired. This content is inserted into the body before any configured contentEl is appended.

Available since: 1.1.0

** IMPORTANT: be sure to specify a <code>layout</code> if needed ! ** A single item, or an array of chi...
** IMPORTANT: be sure to specify a <code>layout</code> if needed ! **

A single item, or an array of child Components to be added to this container, for example:

// specifying a single item
items: {...},
layout: 'fit',    // specify a layout!

// specifying multiple items
items: [{...}, {...}],
layout: 'hbox', // specify a layout!
       

Each item may be:

  • any type of object based on Ext.Component
  • a fully instanciated object or
  • an object literal that:
    • has a specified xtype
    • the Ext.Component.xtype specified is associated with the Component desired and should be chosen from one of the available xtypes as listed in Ext.Component.
    • If an xtype is not explicitly specified, the defaultType for that Container is used.
    • will be "lazily instanciated", avoiding the overhead of constructing a fully instanciated Component object

Notes:

  • Ext uses lazy rendering. Child Components will only be rendered should it become necessary. Items are automatically laid out when they are first shown (no sizing is done while hidden), or in response to a doLayout call.
  • Do not specify contentEl/ html with items.

Available since: 1.1.0

Set this to true to automatically relayout this component on orientation change. ...

Set this to true to automatically relayout this component on orientation change. This property is set to true by default if a component is floating unless you specifically set this to false. Also note that you dont have to set this property to true if this component is a child of a fullscreen container, since fullscreen components are also laid out automatically on orientation change. Defaults to null

Available since: 1.1.0

(optional) A config object containing one or more event handlers to be added to this object during initialization. ...

(optional)

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 child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

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'); }
        }
    }
});

Available since: 1.1.0

Ext.NestedList
view source
: String
Loading text to display when a subtree is loading. ...

Loading text to display when a subtree is loading.

Defaults to: 'Loading...'

Available since: 1.1.0

Specifies the margin for this component. ...

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

Available since: 1.1.0

The maximum value in pixels which this Component will set its height to. ...

The maximum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

Available since: 1.1.0

The maximum value in pixels which this Component will set its width to. ...

The maximum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

Available since: 1.1.0

The minimum value in pixels which this Component will set its height to. ...

The minimum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

Available since: 1.1.0

The minimum value in pixels which this Component will set its width to. ...

The minimum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

Available since: 1.1.0

True to make the Component modal and mask everything behind it when displayed, false to display it without restrictin...

True to make the Component modal and mask everything behind it when displayed, false to display it without restricting access to other UI elements (defaults to false).

Defaults to: false

Available since: 1.1.0

Monitor Orientation change ...

Monitor Orientation change

Defaults to: false

Available since: 1.1.0

Ext.NestedList
view source
: Boolean/Function
Maps to the Ext.List onItemDisclosure configuration for individual lists. ...

Maps to the Ext.List onItemDisclosure configuration for individual lists. (Defaults to false)

Defaults to: false

Available since: 1.1.0

Specifies the padding for this component. ...

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

Available since: 1.1.0

An object or array of objects that will provide custom functionality for this component. ...

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.

Available since: 1.1.0

An object containing properties specifying DomQuery selectors which identify child elements created by the render pro...

An object containing properties specifying DomQuery selectors which identify child elements created by the render process.

After the Component's internal structure is rendered according to the renderTpl, this object is iterated through, and the found Elements are added as properties to the Component using the renderSelector property name.

For example, a Component which rendered an image, and description into its element might use the following properties coded into its prototype:

renderTpl: '<img src="{imageUrl}" class="x-image-component-img"><div class="x-image-component-desc">{description}</div>',

renderSelectors: {
    image: 'img.x-image-component-img',
    descEl: 'div.x-image-component-desc'
}

After rendering, the Component would have a property image referencing its child img Element, and a property descEl referencing the div Element which contains the description.

Available since: 1.1.0

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into. ...

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.

  • Notes :
      Do not use this option if the Component is to be a child item of a Container. It is the responsibility of the Container's layout manager to render and manage its child items.
      When using this config, a call to render() is not required.

See render also.

Available since: 1.1.0

An XTemplate used to create the internal structure inside this Component's encapsulating Element. ...

An XTemplate used to create the internal structure inside this Component's encapsulating Element.

You do not normally need to specify this. For the base classes Ext.Component and Ext.Container, this defaults to null which means that they will be initially rendered with no internal structure; they render their Element empty. The more specialized ExtJS and Touch classes which use a more complex DOM structure, provide their own template definitions.

This is intended to allow the developer to create application-specific utility Components with customized internal structure.

Upon rendering, any created child elements may be automatically imported into object properties using the renderSelectors option.

Defaults to: ['<div class="{baseCls}-body<tpl if="bodyCls"> {bodyCls}</tpl>"<tpl if="bodyStyle"> style="{bodyStyle}"</tpl>></div>']

Available since: 1.1.0

Overrides: Ext.lib.Component.renderTpl

inherited ...

inherited

Defaults to: false

Available since: 1.1.0

Overrides: Ext.Component.scroll

The type of animation you want to use when this component is shown. ...

The type of animation you want to use when this component is shown. If you set this this hide animation will automatically be the opposite.

Available since: 1.1.0

True to stop the event that fires when you click outside the floating component. ...

True to stop the event that fires when you click outside the floating component. Defalts to true.

Defaults to: true

Available since: 1.1.0

The Ext.data.TreeStore to bind this NestedList to.

The Ext.data.TreeStore to bind this NestedList to.

Available since: 1.1.0

A custom style specification to be applied to this component's Element. ...

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.

        new Ext.Panel({
            title: 'Some Title',
            renderTo: Ext.getBody(),
            width: 400, height: 300,
            layout: 'form',
            items: [{
                xtype: 'textareafield',
                style: {
                    width: '95%',
                    marginBottom: '10px'
                }
            },
            new Ext.Button({
                text: 'Send',
                minWidth: '100',
                style: {
                    marginBottom: '10px'
                }
            })
            ]
        });
     

Available since: 1.1.0

The class that is added to the content target when you set styleHtmlContent to true. ...

The class that is added to the content target when you set styleHtmlContent to true. Defaults to 'x-html'

Defaults to: 'x-html'

Available since: 1.1.0

True to automatically style the html inside the content target of this component (body for panels). ...

True to automatically style the html inside the content target of this component (body for panels). Defaults to false.

Defaults to: false

Available since: 1.1.0

Ext.NestedList
view source
: Object

Configuration for the Ext.Toolbar that is created within the Ext.NestedList.

Configuration for the Ext.Toolbar that is created within the Ext.NestedList.

Available since: 1.1.0

The Ext.(X)Template method to use when updating the content area of the Component. ...

The Ext.(X)Template method to use when updating the content area of the Component. Defaults to 'overwrite' (see Ext.XTemplate.overwrite).

Defaults to: 'overwrite'

Available since: 1.1.0

A set of predefined ui styles for individual components. ...

A set of predefined ui styles for individual components.

Most components support 'light' and 'dark'.

Extra string added to the baseCls with an extra '-'.

      new Ext.Panel({
          title: 'Some Title',
          baseCls: 'x-component'
          ui: 'green'
      });
       

The ui configuration in this example would add 'x-component-green' as an additional class.

Available since: 1.1.0

Ext.NestedList
view source
: Boolean
Update the title with the currently selected category. ...

Update the title with the currently selected category. Defaults to true.

Defaults to: true

Available since: 1.1.0

Ext.NestedList
view source
: Boolean
...

Defaults to: true

Available since: 1.1.0

Ext.NestedList
view source
: Boolean
True to show the header toolbar. ...

True to show the header toolbar. Defaults to true.

Defaults to: true

Available since: 1.1.0

The width of this component in pixels.

The width of this component in pixels.

Available since: 1.1.0

Defined By

Properties

...

Defaults to: true

Available since: 1.1.0

...

Defaults to: false

Available since: 1.1.0

...

Defaults to: false

Available since: 1.1.0

Available since: 1.1.0

Read-only property indicating whether or not the component can be dragged ...

Read-only property indicating whether or not the component can be dragged

Defaults to: false

Available since: 1.1.0

...

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal)$/

Available since: 1.1.0

...

Defaults to: true

Available since: 1.1.0

...

Defaults to: true

Available since: 1.1.0

...

Defaults to: true

Available since: 1.1.0

The MixedCollection containing all the child items of this container.

The MixedCollection containing all the child items of this container.

Available since: 1.1.0

...

Defaults to: false

Available since: 1.1.0

Read-only property indicating whether or not the component has been rendered. ...

Read-only property indicating whether or not the component has been rendered.

Defaults to: false

Available since: 1.1.0

Ext.NestedList
view source
: Object

Ext.data.TreeStore

Available since: 1.1.0

Ext.NestedList
view source
: Object
Ext.Toolbar shared across each of the lists. ...

Ext.Toolbar shared across each of the lists. This will only exist when useToolbar is true which is the default.

Available since: 1.1.0

Defined By

Methods

Create a new Panel ...

Create a new Panel

Available since: 1.1.0

Parameters

  • config : Object

    The config object

Returns

Overrides: Ext.Component.constructor, Ext.Panel.constructor

Adds Component(s) to this Container. ...

Adds Component(s) to this Container.


Description :


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:
    var tb = new Ext.Toolbar();
    tb.render(document.body);  // toolbar is rendered
    tb.add({text:'Button 1'}); // add multiple items (defaultType for Toolbar is 'button')
    tb.add({text:'Button 2'});
    tb.doLayout();             // refresh the layout
    
  • Warning: Containers directly managed by the BorderLayout layout manager may not be removed or added. See the Notes for BorderLayout for more details.

Available since: 1.1.0

Parameters

  • component : ...Object/Array

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

Returns

Fires

...

Available since: 1.1.0

Adds a CSS class to the top level element representing this component. ...

Adds a CSS class to the top level element representing this component.

Available since: 1.1.0

Returns

Adds docked item(s) to the panel. ...

Adds docked item(s) to the panel.

Available since: 1.1.0

Parameters

  • 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').

  • pos : Number (optional)

    The index at which the Component will be added

Fires

    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.

    Available since: 1.1.0

    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');
      
    ( element, listeners, scope, options )
    ...

    Available since: 1.1.0

    Parameters

    • element : Object
    • listeners : Object
    • scope : Object
    • options : Object

    Fires

      Overrides: Ext.util.Observable.addListener

      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.

      Available since: 1.1.0

      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.

      Fires

        Ext.NestedList
        view source
        ( recordNode, swapTo )private
        ...

        Available since: 1.1.0

        Parameters

        • recordNode : Object
        • swapTo : Object

        Fires

        ...

        Available since: 1.1.0

        Parameters

        • offset : Object

        Fires

          Template method that can be overriden to perform logic after the panel has layed out itself e.g. ...

          Template method that can be overriden to perform logic after the panel has layed out itself e.g. Resized the body and positioned all docked items.

          Available since: 1.1.0

          Overrides: Ext.lib.Component.afterComponentLayout

          ...

          Available since: 1.1.0

          Parameters

          • layout : Object

          Fires

          Overrides: Ext.lib.Container.afterLayout

          ...

          Available since: 1.1.0

          Overrides: Ext.lib.Container.afterRender

          ( alignTo, allowSides, offset )private
          ...

          Available since: 1.1.0

          Parameters

          • alignTo : Object
          • allowSides : Object
          • offset : Object

          Fires

          ...

          Available since: 1.1.0

          Parameters

          • config : Object
          Sets references to elements inside the component. ...

          Sets references to elements inside the component. E.g body -> x-panel-body

          Available since: 1.1.0

          ...

          Available since: 1.1.0

          ...

          Available since: 1.1.0

          Fires

            Overrides: Ext.lib.Container.beforeDestroy

            Retrieves the first direct child of this container which matches the passed selector. ...

            Retrieves the first direct child of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector.

            Available since: 1.1.0

            Parameters

            Returns

            Fires

              Removes all listeners for this object including the managed listeners ...

              Removes all listeners for this object including the managed listeners

              Available since: 1.1.0

              Fires

                Removes all managed listeners for this object. ...

                Removes all managed listeners for this object.

                Available since: 1.1.0

                ( config, defaultType )private
                ...

                Available since: 1.1.0

                Parameters

                • config : Object
                • defaultType : Object
                Destroys the Component. ...

                Destroys the Component.

                Available since: 1.1.0

                Fires

                Disable this container by masking out ...

                Disable this container by masking out

                Available since: 1.1.0

                Overrides: Ext.lib.Component.disable

                ( width, height, isSetSize ) : Ext.Containerchainable
                This method needs to be called whenever you change something on this component that requires the components layout to...

                This method needs to be called whenever you change something on this component that requires the components layout to be recalculated. An example is adding, showing or hiding a docked item to a Panel, or changing the label of a form field. After a component layout, the container layout will automatically be run. So you could be on the safe side and always call doComponentLayout instead of doLayout.

                Available since: 1.1.0

                Parameters

                • width : Object
                • height : Object
                • isSetSize : Object

                Returns

                Fires

                  ( el, options )private
                  private ...

                  private

                  Available since: 1.1.0

                  Parameters

                  • el : Object
                  • options : Object

                  Fires

                  Force this container's layout to be recalculated. ...

                  Force this container's layout to be recalculated. A call to this function is required after adding a new component to an already rendered container, or possibly after changing sizing/position properties of child components.

                  Available since: 1.1.0

                  Returns

                  Fires

                    ( component, autoDestroy )private
                    ...

                    Available since: 1.1.0

                    Parameters

                    • component : Object
                    • autoDestroy : Object

                    Fires

                      Retrieves the first descendant of this container which matches the passed selector. ...

                      Retrieves the first descendant of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector.

                      Available since: 1.1.0

                      Parameters

                      Returns

                      Fires

                        Enable this container by removing mask ...

                        Enable this container by removing mask

                        Available since: 1.1.0

                        Overrides: Ext.lib.Component.enable

                        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');
                            }
                        }
                        });
                        

                        Available since: 1.1.0

                        Parameters

                        • events : String/Array

                          The event name to bubble, or an Array of event names.

                        ( eventName, 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).

                        An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

                        Available since: 1.1.0

                        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.

                        Fires

                          Returns the current activeItem for the layout (only for a card layout) ...

                          Returns the current activeItem for the layout (only for a card layout)

                          Available since: 1.1.0

                          Returns

                          • activeItem

                            activeItem Current active component

                          Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. ...

                          Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.

                          Available since: 1.1.0

                          Returns

                          ...

                          Available since: 1.1.0

                          Attempts a default component lookup (see Ext.Container.getComponent). ...

                          Attempts a default component lookup (see Ext.Container.getComponent). If the component is not found in the normal items, the dockedItems are searched and the matched component (if any) returned (see getDockedComponent).

                          Available since: 1.1.0

                          Parameters

                          • comp : String/Number

                            The docked component id or itemId to find

                          Returns

                          Fires

                            Overrides: Ext.lib.Container.getComponent

                            used as the key lookup function for the items collection ...
                            • used as the key lookup function for the items collection

                            Available since: 1.1.0

                            Parameters

                            • comp : Object
                            ...

                            Available since: 1.1.0

                            Fires

                              Ext.NestedList
                              view source
                              ( record, parentRecord )
                              Implement getDetailCard to provide a final card for leaf nodes. ...

                              Implement getDetailCard to provide a final card for leaf nodes. This is useful when you want to display details about each node, instead of simply reaching the listing all of the nodes at the bottom level of the tree. See the intro docs for sample usage. The default implementation will return false, which means no detail card will be inserted

                              Available since: 1.1.0

                              Parameters

                              • record : Ext.data.Record
                              • parentRecord : Ext.data.Record
                              Finds a docked component by id, itemId or position ...

                              Finds a docked component by id, itemId or position

                              Available since: 1.1.0

                              Parameters

                              • comp : String/Number

                                The id, itemId or position of the child component (see getComponent for details)

                              Returns

                              Retrieve an array of all currently docked components. ...

                              Retrieve an array of all currently docked components.

                              Available since: 1.1.0

                              Returns

                              • Array

                                An array of components.

                              Retrieves the top level element representing this component. ...

                              Retrieves the top level element representing this component.

                              Available since: 1.1.0

                              ...

                              Available since: 1.1.0

                              Gets the current height of the component's underlying element. ...

                              Gets the current height of the component's underlying element.

                              Available since: 1.1.0

                              Returns

                              • Number
                              Retrieves the id of this component. ...

                              Retrieves the id of this component. Will autogenerate an id if one has not already been set.

                              Available since: 1.1.0

                              This function takes the position argument passed to onRender and returns a DOM element that you can use in the insert...

                              This function takes the position argument passed to onRender and returns a DOM element that you can use in the insertBefore.

                              Available since: 1.1.0

                              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

                              ...

                              Available since: 1.1.0

                              Ext.NestedList
                              view source
                              ( node )
                              Override this method to provide custom template rendering of individual nodes. ...

                              Override this method to provide custom template rendering of individual nodes. The template will receive all data within the Record and will also receive whether or not it is a leaf node.

                              Available since: 1.1.0

                              Parameters

                              • node : Ext.data.Record
                              ...

                              Available since: 1.1.0

                              Fires

                                Returns the layout instance currently associated with this Container. ...

                                Returns the layout instance currently associated with this Container. If a layout has not been instantiated yet, that is done first

                                Available since: 1.1.0

                                Returns

                                Fires

                                  Ext.NestedList
                                  view source
                                  ( node )private
                                  Returns the list config for a specified node. ...

                                  Returns the list config for a specified node.

                                  Available since: 1.1.0

                                  Parameters

                                  • node : HTMLElement

                                    The node for the list config

                                  Fires

                                    Used by ComponentQuery to retrieve all of the items which can potentially be considered a child of this Container. ...

                                    Used by ComponentQuery to retrieve all of the items which can potentially be considered a child of this Container. This should be overriden by components which have child items that are not contained in items. For example dockedItems, menu, etc

                                    Available since: 1.1.0

                                    Parameters

                                    • deep : Object

                                    Fires

                                      Overrides: Ext.lib.Container.getRefItems

                                      Gets the current size of the component's underlying element. ...

                                      Gets the current size of the component's underlying element.

                                      Available since: 1.1.0

                                      Returns

                                      • Object

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

                                      Ext.NestedList
                                      view source
                                      ( node )
                                      Returns the subList for a specified node ...

                                      Returns the subList for a specified node

                                      Available since: 1.1.0

                                      Parameters

                                      • node : HTMLElement

                                        The node for the subList

                                      Fires

                                        This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component. ...

                                        This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component.

                                        Available since: 1.1.0

                                        Overrides: Ext.lib.Component.getTargetEl

                                        Ext.NestedList
                                        view source
                                        ( node )
                                        Override this method to provide custom template rendering of titles/back buttons when useTitleAsBackText is enabled. ...

                                        Override this method to provide custom template rendering of titles/back buttons when useTitleAsBackText is enabled.

                                        Available since: 1.1.0

                                        Parameters

                                        • node : Ext.data.Record
                                        Gets the current width of the component's underlying element. ...

                                        Gets the current width of the component's underlying element.

                                        Available since: 1.1.0

                                        Returns

                                        • Number
                                        Returns this Component's xtype hierarchy as a slash-delimited string. ...

                                        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'
                                        

                                        Available since: 1.1.0

                                        Returns

                                        • String

                                          The xtype hierarchy string

                                        ...

                                        Available since: 1.1.0

                                        Parameters

                                        • isAdding : Object
                                        • item : Object

                                        Fires

                                          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

                                          Available since: 1.1.0

                                          Parameters

                                          • eventName : String

                                            The name of the event to check for

                                          Returns

                                          • Boolean

                                            True if the event is being listened for, else false

                                          Hide the component ...

                                          Hide the component

                                          Available since: 1.1.0

                                          Parameters

                                          • animation : Object/String/Boolean (optional)

                                            Defaults to false.

                                          Returns

                                          Fires

                                          Function description ...

                                          Function description

                                          Available since: 1.1.0

                                          Returns

                                          • String

                                            A CSS style string with style, padding, margin and border.

                                          Creates an array of class names from the configurations to add to this Component's el on render. ...

                                          Creates an array of class names from the configurations to add to this Component's el on render.

                                          Private, but (possibly) used by ComponentQuery for selection by class name if Component is not rendered.

                                          Available since: 1.1.0

                                          Returns

                                          • Array

                                            An array of class names with which the Component's element will be rendered.

                                          Ext.NestedList
                                          view source
                                          ( )private
                                          ...

                                          Available since: 1.1.0

                                          Fires

                                            Overrides: Ext.Container.initComponent

                                            Adds ctCls to container. ...

                                            Adds ctCls to container.

                                            Available since: 1.1.0

                                            Parameters

                                            • container : Object

                                            Returns

                                            Initializes this components contents. ...

                                            Initializes this components contents. It checks for the properties html, contentEl and tpl/data.

                                            Available since: 1.1.0

                                            Fires

                                              ...

                                              Available since: 1.1.0

                                              Overrides: Ext.lib.Component.initEvents

                                              ...

                                              Available since: 1.1.0

                                              Fires

                                                Overrides: Ext.lib.Container.initItems

                                                ...

                                                Available since: 1.1.0

                                                Parameters

                                                • plugin : Object
                                                Initialized the renderData to be used when rendering the renderTpl. ...

                                                Initialized the renderData to be used when rendering the renderTpl.

                                                Available since: 1.1.0

                                                Returns

                                                • Object

                                                  Object with keys and values that are going to be applied to the renderTpl

                                                Fires

                                                  Overrides: Ext.lib.Component.initRenderData

                                                  Initializes the renderTpl. ...

                                                  Initializes the renderTpl.

                                                  Available since: 1.1.0

                                                  Returns

                                                  Function description ...

                                                  Function description

                                                  Available since: 1.1.0

                                                  Returns

                                                  • String

                                                    A CSS style string with style, padding, margin and border.

                                                  Inserts a Component into this Container at a specified index. ...

                                                  Inserts a Component into this Container at a specified index. Fires the beforeadd event before inserting, then fires the add event after the Component has been inserted.

                                                  Available since: 1.1.0

                                                  Parameters

                                                  • index : Number

                                                    The index at which the Component will be inserted into the Container's items collection

                                                  • component : Ext.Component

                                                    The child Component to insert.

                                                    Ext uses lazy rendering, and will only render the inserted Component should it become necessary.

                                                    A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this 'lazy instantiation', set the Ext.Component.xtype config property to the registered type of the Component wanted.

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

                                                  Returns

                                                  • Ext.Component

                                                    component The Component (or config object) that was inserted with the Container's default config values applied.

                                                  Fires

                                                  Inserts docked item(s) to the panel at the indicated position. ...

                                                  Inserts docked item(s) to the panel at the indicated position.

                                                  Available since: 1.1.0

                                                  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').

                                                  Fires

                                                    ...

                                                    Available since: 1.1.0

                                                    Parameters

                                                    • selector : Object
                                                    Method to determine whether this Component is currently disabled. ...

                                                    Method to determine whether this Component is currently disabled.

                                                    Available since: 1.1.0

                                                    Returns

                                                    • Boolean

                                                      the disabled state of this Component.

                                                    Method to determine whether this Component is draggable. ...

                                                    Method to determine whether this Component is draggable.

                                                    Available since: 1.1.0

                                                    Returns

                                                    • Boolean

                                                      the draggable state of this component.

                                                    Method to determine whether this Component is droppable. ...

                                                    Method to determine whether this Component is droppable.

                                                    Available since: 1.1.0

                                                    Returns

                                                    • Boolean

                                                      the droppable state of this component.

                                                    Method to determine whether this Component is floating. ...

                                                    Method to determine whether this Component is floating.

                                                    Available since: 1.1.0

                                                    Returns

                                                    • Boolean

                                                      the floating state of this component.

                                                    Method to determine whether this Component is currently set to hidden. ...

                                                    Method to determine whether this Component is currently set to hidden.

                                                    Available since: 1.1.0

                                                    Returns

                                                    • Boolean

                                                      the hidden state of this Component.

                                                    Returns true if this component is visible. ...

                                                    Returns true if this component is visible.

                                                    Available since: 1.1.0

                                                    Returns

                                                    • Boolean

                                                      True if this component is visible, false otherwise.

                                                    ( xtype, [shallow] ) : Boolean
                                                    Tests whether or not this Component is of a specific xtype. ...

                                                    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
                                                    

                                                    Available since: 1.1.0

                                                    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.

                                                    Fires

                                                      ...

                                                      Available since: 1.1.0

                                                      ...

                                                      Available since: 1.1.0

                                                      Parameters

                                                      • comp : Object

                                                      Fires

                                                        Returns the next sibling of this Component. ...

                                                        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()

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • selector : Object

                                                          Optional. A ComponentQuery selector to filter the following items.

                                                        Returns

                                                        • Object

                                                          The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

                                                        ( eventName, handler, [scope], [options] )
                                                        Appends an event handler to this object (shorthand for addListener.) ...

                                                        Appends an event handler to this object (shorthand for addListener.)

                                                        Available since: 1.1.0

                                                        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.

                                                        ...

                                                        Available since: 1.1.0

                                                        ( container, pos )private
                                                        Method to manage awareness of when components are added to their respective Container, firing an added event. ...

                                                        Method to manage awareness of when components are added to their respective Container, firing an added event. References are established at add time rather than at render time.

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • container : Ext.Container

                                                          Container which holds the component

                                                        • pos : number

                                                          Position at which the component was added

                                                        Fires

                                                        Ext.NestedList
                                                        view source
                                                        ( )
                                                        Called when the backButton has been tapped ...

                                                        Called when the backButton has been tapped

                                                        Available since: 1.1.0

                                                        Fires

                                                        ...

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • item : Object
                                                        ( newCard, oldCard, newIndex, animated )private
                                                        A template method that can be implemented by subclasses of Container. ...

                                                        A template method that can be implemented by subclasses of Container. By returning false we can cancel the card switch.

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • newCard : Ext.Component

                                                          The card that will be switched to

                                                        • oldCard : Ext.Component

                                                          The card that will be switched from

                                                        • newIndex : Number

                                                          The Container index position of the selected card

                                                        • animated : Boolean

                                                          True if this cardswitch will be animated

                                                        Fires

                                                        ( newCard, oldCard, newIndex, animated )private
                                                        A template method that can be implemented by subclasses of Container. ...

                                                        A template method that can be implemented by subclasses of Container. If the card is switched using an animation, this method will be called after the animation has finished.

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • newCard : Ext.Component

                                                          The card that has been switched to

                                                        • oldCard : Ext.Component

                                                          The card that has been switched from

                                                        • newIndex : Number

                                                          The Container index position of the selected card

                                                        • animated : Boolean

                                                          True if this cardswitch was animated

                                                        Fires

                                                        ...

                                                        Available since: 1.1.0

                                                        Overrides: Ext.lib.Component.onDestroy

                                                        ...

                                                        Available since: 1.1.0

                                                        Placeholder empty functions ...

                                                        Placeholder empty functions

                                                        Available since: 1.1.0

                                                        ...

                                                        Available since: 1.1.0

                                                        ...

                                                        Available since: 1.1.0

                                                        ...

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • key : Object
                                                        • field : Object

                                                        Fires

                                                          ...

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • field : Object
                                                          • e : Object
                                                          ...

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • field : Object
                                                          • e : Object
                                                          ...

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • field : Object
                                                          • e : Object

                                                          Fires

                                                            ...

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • field : Object
                                                            • e : Object

                                                            Fires

                                                              ...

                                                              Available since: 1.1.0

                                                              Parameters

                                                              • key : Object
                                                              • field : Object

                                                              Fires

                                                                ...

                                                                Available since: 1.1.0

                                                                ...

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • e : Object

                                                                Fires

                                                                ( animation, fireHideEvent )private
                                                                ...

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • animation : Object
                                                                • fireHideEvent : Object

                                                                Fires

                                                                ...

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • me : Object
                                                                • item : Object
                                                                ...

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • me : Object
                                                                • item : Object
                                                                Ext.NestedList
                                                                view source
                                                                ( subList, subIdx, el, e )
                                                                Called when an list item has been tapped ...

                                                                Called when an list item has been tapped

                                                                Available since: 1.1.0

                                                                Parameters

                                                                Fires

                                                                ...

                                                                Available since: 1.1.0

                                                                Called after the component is moved, this method is empty by default but can be implemented by any subclass that need...

                                                                Called after the component is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs.

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • x : Number

                                                                  The new x position

                                                                • y : Number

                                                                  The new y position

                                                                ...

                                                                Available since: 1.1.0

                                                                Method to manage awareness of when components are removed from their respective Container, firing an removed event. ...

                                                                Method to manage awareness of when components are removed from their respective Container, firing an removed event. References are properly cleaned up after removing a component from its owning container.

                                                                Available since: 1.1.0

                                                                Fires

                                                                ...

                                                                Available since: 1.1.0

                                                                Fires

                                                                Overrides: Ext.lib.Component.onRender

                                                                ...

                                                                Available since: 1.1.0

                                                                ( animation )private
                                                                ...

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • animation : Object

                                                                Fires

                                                                Overrides: Ext.lib.Component.onShow

                                                                ( items, applyDefaults )private
                                                                ...

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • items : Object
                                                                • applyDefaults : Object

                                                                Fires

                                                                  Returns the previous sibling of this Component. ...

                                                                  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()

                                                                  Available since: 1.1.0

                                                                  Parameters

                                                                  • selector : Object

                                                                    Optional. A ComponentQuery selector to filter the preceding items.

                                                                  Returns

                                                                  • Object

                                                                    The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

                                                                  ...

                                                                  Available since: 1.1.0

                                                                  ...

                                                                  Available since: 1.1.0

                                                                  Retrieves all descendant components which match the passed selector. ...

                                                                  Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.

                                                                  Available since: 1.1.0

                                                                  Parameters

                                                                  Returns

                                                                  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.

                                                                  Available since: 1.1.0

                                                                  Parameters

                                                                  • o : Object

                                                                    The Observable whose events this object is to relay.

                                                                  • events : Array

                                                                    Array of event names to relay.

                                                                  Removes a component from this container. ...

                                                                  Removes a component from this container. Fires the beforeremove event before removing, then fires the remove event after the component has been removed.

                                                                  Available since: 1.1.0

                                                                  Parameters

                                                                  • component : Component/String

                                                                    The component reference or id to remove.

                                                                  • autoDestroy : Boolean (optional)

                                                                    True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config.

                                                                  Returns

                                                                  Fires

                                                                  Removes all components from this container. ...

                                                                  Removes all components from this container.

                                                                  Available since: 1.1.0

                                                                  Parameters

                                                                  • autoDestroy : Boolean (optional)

                                                                    True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config.

                                                                  Returns

                                                                  • Array

                                                                    Array of the destroyed components

                                                                  Fires

                                                                  ...

                                                                  Available since: 1.1.0

                                                                  Removes a CSS class from the top level element representing this component. ...

                                                                  Removes a CSS class from the top level element representing this component.

                                                                  Available since: 1.1.0

                                                                  Returns

                                                                  Removes the docked item from the panel. ...

                                                                  Removes the docked item from the panel.

                                                                  Available since: 1.1.0

                                                                  Parameters

                                                                  • item : Ext.Component

                                                                    . The Component to remove.

                                                                  • autoDestroy : Boolean (optional)

                                                                    Destroy the component after removal.

                                                                  Fires

                                                                    ( eventName, handler, [scope] )
                                                                    Removes an event handler. ...

                                                                    Removes an event handler.

                                                                    Available since: 1.1.0

                                                                    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.

                                                                    Fires

                                                                      Removes listeners that were added by the mon method. ...

                                                                      Removes listeners that were added by the mon method.

                                                                      Available since: 1.1.0

                                                                      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.

                                                                      Fires

                                                                        ( container, position ) : Ext.lib.Componentchainableprivate
                                                                        ...

                                                                        Available since: 1.1.0

                                                                        Parameters

                                                                        • container : Object
                                                                        • position : Object

                                                                        Returns

                                                                        Fires

                                                                        Ext.NestedList
                                                                        view source
                                                                        ( node )private
                                                                        private ...

                                                                        private

                                                                        Available since: 1.1.0

                                                                        Parameters

                                                                        • node : Object

                                                                        Fires

                                                                          ...

                                                                          Available since: 1.1.0

                                                                          Resume firing events. ...

                                                                          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.

                                                                          Available since: 1.1.0

                                                                          ( card, [cardSwitchAnimation] ) : Ext.Containerchainable
                                                                          Allows you to set the active card in this container. ...

                                                                          Allows you to set the active card in this container. This method is only available if the container uses a CardLayout. Note that a Carousel and TabPanel both get a CardLayout automatically, so both of those components are able to use this method.

                                                                          Available since: 1.1.0

                                                                          Parameters

                                                                          • card : Ext.Component/Number/Object

                                                                            The card you want to be made active. A number is interpreted as a card index. An object will be converted to a Component using the objects xtype property, then added to the container and made active. Passing a Component will make sure the component is a child of this container, and then make it active.

                                                                          • cardSwitchAnimation : String/Object (optional)

                                                                            The cardSwitchAnimation used to switch between the cards. This can be an animation type string or an animation configuration object.

                                                                          Returns

                                                                          Ext.NestedList
                                                                          view source
                                                                          ( path )private
                                                                          ...

                                                                          Available since: 1.1.0

                                                                          Parameters

                                                                          • path : Object

                                                                          Fires

                                                                          ...

                                                                          Available since: 1.1.0

                                                                          Parameters

                                                                          • width : Object
                                                                          • height : Object

                                                                          Returns

                                                                          Fires

                                                                            ...

                                                                            Available since: 1.1.0

                                                                            Show this component centered of its parent or the window This only applies when the component is floating. ...

                                                                            Show this component centered of its parent or the window This only applies when the component is floating.

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • centered : Boolean

                                                                              True to center, false to remove centering

                                                                            Returns

                                                                            Fires

                                                                            ...

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • layout : Object
                                                                            Enable or disable the component. ...

                                                                            Enable or disable the component.

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • disabled : Boolean
                                                                            ( dock, layoutParent ) : Componentchainable
                                                                            Sets the dock position of this component in its parent panel. ...

                                                                            Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part of the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • dock : Object
                                                                            • layoutParent : Object

                                                                            Returns

                                                                            • Component

                                                                              this

                                                                            Sets a Component as draggable. ...

                                                                            Sets a Component as draggable.

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • draggable : Boolean/Mixed

                                                                              On first call, this can be a config object for Ext.util.Draggable. Afterwards, if set to false, the existing draggable object will be disabled

                                                                            • autoShow : Boolean

                                                                            Fires

                                                                            Sets a Component as floating. ...

                                                                            Sets a Component as floating.

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • floating : Boolean
                                                                            • autoShow : Boolean

                                                                            Fires

                                                                            Sets the height of the component. ...

                                                                            Sets the height of the component. This method fires the resize event.

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • height : Number

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

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

                                                                            Returns

                                                                            Fires

                                                                              ...

                                                                              Available since: 1.1.0

                                                                              Parameters

                                                                              • layout : Object
                                                                              This method allows you to show or hide a LoadMask on top of this component. ...

                                                                              This method allows you to show or hide a LoadMask on top of this component.

                                                                              Available since: 1.1.0

                                                                              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.

                                                                              Fires

                                                                                ( orientation, width, height )
                                                                                Sets the orientation for the Panel. ...

                                                                                Sets the orientation for the Panel.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                • orientation : String

                                                                                  'landscape' or 'portrait'

                                                                                • width : Number/String

                                                                                  New width of the Panel.

                                                                                • height : Number/String

                                                                                  New height of the Panel.

                                                                                Fires

                                                                                Sets the left and top of the component. ...

                                                                                Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires the move event.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                • left : Number

                                                                                  The new left

                                                                                • top : Number

                                                                                  The new top

                                                                                Returns

                                                                                Fires

                                                                                Sets a Component as scrollable. ...

                                                                                Sets a Component as scrollable.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                • config : Mixed

                                                                                  Acceptable values are a Ext.Scroller configuration, 'horizontal', 'vertical', 'both', and false

                                                                                Fires

                                                                                  Sets the width and height of this Component. ...

                                                                                  Sets the width and height of this Component. This method fires the resize event. This method can accept either width and height as separate arguments, or you can pass a size object like {width:10, height:20}.

                                                                                  Available since: 1.1.0

                                                                                  Parameters

                                                                                  • width : Mixed

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

                                                                                    • A Number specifying the new width in the Element's Ext.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.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

                                                                                  Fires

                                                                                    Convenience function to hide or show this component by boolean. ...

                                                                                    Convenience function to hide or show this component by boolean.

                                                                                    Available since: 1.1.0

                                                                                    Parameters

                                                                                    • visible : Boolean

                                                                                      True to show, false to hide

                                                                                    Returns

                                                                                    Sets the width of the component. ...

                                                                                    Sets the width of the component. This method fires the resize event.

                                                                                    Available since: 1.1.0

                                                                                    Parameters

                                                                                    • width : Number

                                                                                      The new width to setThis may be one of:

                                                                                    Returns

                                                                                    Fires

                                                                                      inherit docs ...

                                                                                      inherit docs

                                                                                      Available since: 1.1.0

                                                                                      Returns

                                                                                      Fires

                                                                                      Overrides: Ext.Component.show

                                                                                      ( alignTo, animation, allowOnSide ) : Ext.Componentchainable
                                                                                      Show this component relative another component or element. ...

                                                                                      Show this component relative another component or element.

                                                                                      Available since: 1.1.0

                                                                                      Parameters

                                                                                      • alignTo : Mixed

                                                                                        Element or Component

                                                                                      • animation : Object/String/Boolean
                                                                                      • allowOnSide : Boolean

                                                                                        true to allow this element to be aligned on the left or right.

                                                                                      Returns

                                                                                      Fires

                                                                                      Suspend the firing of all events. ...

                                                                                      Suspend the firing of all events. (see resumeEvents)

                                                                                      Available since: 1.1.0

                                                                                      Parameters

                                                                                      • queueSuspended : Boolean

                                                                                        Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

                                                                                      Ext.NestedList
                                                                                      view source
                                                                                      ( card )private
                                                                                      ...

                                                                                      Available since: 1.1.0

                                                                                      Parameters

                                                                                      • card : Object

                                                                                      Fires

                                                                                        ( eventName, handler, [scope] )
                                                                                        Removes an event handler (shorthand for removeListener.) ...

                                                                                        Removes an event handler (shorthand for removeListener.)

                                                                                        Available since: 1.1.0

                                                                                        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.

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

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

                                                                                        Example:

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

                                                                                        Available since: 1.1.0

                                                                                        Parameters

                                                                                        • selector : String

                                                                                          Optional. The simple selector to test.

                                                                                        Returns

                                                                                        • Ext.Container

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

                                                                                        Inherit docs ...

                                                                                        Inherit docs

                                                                                        Available since: 1.1.0

                                                                                        Fires

                                                                                          Overrides: Ext.lib.Component.update

                                                                                          Defined By

                                                                                          Events

                                                                                          Fires after a Component has been visually activated. ...

                                                                                          Fires after a Component has been visually activated.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          ( this, component, index )
                                                                                          @bubbles Fires after any Ext.Component is added or inserted into the container. ...

                                                                                          @bubbles Fires after any Ext.Component is added or inserted into the container.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Container
                                                                                          • component : Ext.Component

                                                                                            The component that was added

                                                                                          • index : Number

                                                                                            The index at which the component was added to the container's items collection

                                                                                          ( this, container, pos )
                                                                                          Fires after a Component had been added to a Container. ...

                                                                                          Fires after a Component had been added to a Container.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires when the components in this container are arranged by the associated layout manager. ...

                                                                                          Fires when the components in this container are arranged by the associated layout manager.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Container
                                                                                          • layout : ContainerLayout

                                                                                            The ContainerLayout implementation for this container

                                                                                          Fires after the component rendering is finished. ...

                                                                                          Fires after the component rendering is finished.

                                                                                          The afterrender event is fired after this Component has been rendered, been postprocesed by any afterRender method defined for the Component, and, if stateful, after state has been restored.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires before a Component has been visually activated. ...

                                                                                          Fires before a Component has been visually activated. Returning false from an event listener can prevent the activate from occurring.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          ( this, component, index )
                                                                                          Fires before any Ext.Component is added or inserted into the container. ...

                                                                                          Fires before any Ext.Component is added or inserted into the container. A handler can return false to cancel the add.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Container
                                                                                          • component : Ext.Component

                                                                                            The component being added

                                                                                          • index : Number

                                                                                            The index at which the component will be added to the container's items collection

                                                                                          ( this, newCard, oldCard, index, animated )
                                                                                          Fires before this container switches the active card. ...

                                                                                          Fires before this container switches the active card. This event is only available if this container uses a CardLayout. Note that TabPanel and Carousel both get a CardLayout by default, so both will have this event. A handler can return false to cancel the card switch.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Container
                                                                                          • newCard : Ext.Component

                                                                                            The card that will be switched to

                                                                                          • oldCard : Ext.Component

                                                                                            The card that will be switched from

                                                                                          • index : Number

                                                                                            The index of the card that will be switched to

                                                                                          • animated : Boolean

                                                                                            True if this cardswitch will be animated

                                                                                          Fires before a Component has been visually deactivated. ...

                                                                                          Fires before a Component has been visually deactivated. Returning false from an event listener can prevent the deactivate from occurring.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires before the component is destroyed. ...

                                                                                          Fires before the component is destroyed. Return false from an event handler to stop the destroy.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires before the component is hidden when calling the hide method. ...

                                                                                          Fires before the component is hidden when calling the hide method. Return false from an event handler to stop the hide.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          ( this, orientation, width, height )
                                                                                          Fires before the orientation changes, if the monitorOrientation configuration is set to true. ...

                                                                                          Fires before the orientation changes, if the monitorOrientation configuration is set to true. Return false to stop the orientation change.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Panel
                                                                                          • orientation : String

                                                                                            'landscape' or 'portrait'

                                                                                          • width : Number
                                                                                          • height : Number
                                                                                          Fires before any Ext.Component is removed from the container. ...

                                                                                          Fires before any Ext.Component is removed from the container. A handler can return false to cancel the remove.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires before the component is rendered. ...

                                                                                          Fires before the component is rendered. Return false from an event handler to stop the render.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Ext.NestedList
                                                                                          view source
                                                                                          ( list, node, selections )
                                                                                          Fires before a selection is made. ...

                                                                                          Fires before a selection is made. If any handlers return false, the selection is cancelled.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • list : Ext.List

                                                                                            The Ext.List that is currently active

                                                                                          • node : HTMLElement

                                                                                            The node to be selected

                                                                                          • selections : Array

                                                                                            Array of currently selected nodes

                                                                                          Fires before the component is shown when calling the show method. ...

                                                                                          Fires before the component is shown when calling the show method. Return false from an event handler to stop the show.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the Panel has been resized. ...

                                                                                          Fires after the Panel has been resized.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • p : Ext.Panel

                                                                                            the Panel which has been resized.

                                                                                          • width : Number

                                                                                            The Panel body's new width.

                                                                                          • height : Number

                                                                                            The Panel body's new height.

                                                                                          ( this, newCard, oldCard, index, animated )
                                                                                          Fires after this container switches the active card. ...

                                                                                          Fires after this container switches the active card. If the card is switched using an animation, this event will fire after the animation has finished. This event is only available if this container uses a CardLayout. Note that TabPanel and Carousel both get a CardLayout by default, so both will have this event.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Container
                                                                                          • newCard : Ext.Component

                                                                                            The card that has been switched to

                                                                                          • oldCard : Ext.Component

                                                                                            The card that has been switched from

                                                                                          • index : Number

                                                                                            The index of the card that has been switched to

                                                                                          • animated : Boolean

                                                                                            True if this cardswitch was animated

                                                                                          Ext.NestedList
                                                                                          view source
                                                                                          ( list, e )
                                                                                          Fires when a tap occurs and it is not on a template node. ...

                                                                                          Fires when a tap occurs and it is not on a template node.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after a Component has been visually deactivated. ...

                                                                                          Fires after a Component has been visually deactivated.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the component is destroyed. ...

                                                                                          Fires after the component is destroyed.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the component is disabled. ...

                                                                                          Fires after the component is disabled.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the component is enabled. ...

                                                                                          Fires after the component is enabled.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the component is hidden. ...

                                                                                          Fires after the component is hidden. Fires after the component is hidden when calling the hide method.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Ext.NestedList
                                                                                          view source
                                                                                          ( list, index, item, e )
                                                                                          Fires when a node is double tapped on ...

                                                                                          Fires when a node is double tapped on

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Ext.NestedList
                                                                                          view source
                                                                                          ( list, index, item, e )
                                                                                          Fires when a node is tapped on ...

                                                                                          Fires when a node is tapped on

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Ext.NestedList
                                                                                          view source
                                                                                          ( subList, subIdx, el, e, card )
                                                                                          Fires when the user taps a leaf list item ...

                                                                                          Fires when the user taps a leaf list item

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Ext.NestedList
                                                                                          view source
                                                                                          ( this, listitem )
                                                                                          Fires when the user taps a list item ...

                                                                                          Fires when the user taps a list item

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the component is moved. ...

                                                                                          Fires after the component is moved.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Component
                                                                                          • x : Number

                                                                                            The new x position

                                                                                          • y : Number

                                                                                            The new y position

                                                                                          ( this, orientation, width, height )
                                                                                          Fires when the orientation changes, if the monitorOrientation configuration is set to true. ...

                                                                                          Fires when the orientation changes, if the monitorOrientation configuration is set to true.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • this : Ext.Panel
                                                                                          • orientation : String

                                                                                            'landscape' or 'portrait'

                                                                                          • width : Number
                                                                                          • height : Number
                                                                                          @bubbles Fires after any Ext.Component is removed from the container. ...

                                                                                          @bubbles Fires after any Ext.Component is removed from the container.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires when a component is removed from an Ext.Container ...

                                                                                          Fires when a component is removed from an Ext.Container

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the component markup is rendered. ...

                                                                                          Fires after the component markup is rendered.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          ( this, adjWidth, adjHeight, rawWidth, rawHeight )
                                                                                          Fires after the component is resized. ...

                                                                                          Fires after the component is resized.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • 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

                                                                                          Ext.NestedList
                                                                                          view source
                                                                                          ( list, selections )
                                                                                          Fires when the selected nodes change. ...

                                                                                          Fires when the selected nodes change.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          Fires after the component is shown when calling the show method. ...

                                                                                          Fires after the component is shown when calling the show method.

                                                                                          Available since: 1.1.0

                                                                                          Parameters