Sencha Documentation

Ext.ComponentMgr

Overview

Super classes

Ext.AbstractManager

Provides a registry of all Components (instances of Ext.Component or any subclass thereof) on a page so that they can be easily accessed by component id (see get, or the convenience method Ext.getCmp).

This object also provides a registry of available Component classes indexed by a mnemonic code known as the Component's xtype. The xtype provides a way to avoid instantiating child Components when creating a full, nested config object for a complete Ext page.

A child Component may be specified simply as a config object as long as the correct xtype is specified so that if and when the Component needs rendering, the correct type can be looked up for lazy instantiation.

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

Properties

 
all : Ext.util.MixedCollection
Contains all of the items currently managed
Contains all of the items currently managed

Methods

 
create( Object config, Constructor defaultType ) : Ext.Component
Creates a new Component from the specified config object using the config object's xtype to determine the class to in...
Creates a new Component from the specified config object using the config object's xtype to determine the class to instantiate.

Parameters

  • config : Object
    A configuration object for the Component you wish to create.
  • defaultType : Constructor
    The constructor to provide the default Component type if the config object does not contain a xtype. (Optional if the config contains a xtype).

Returns

  • Ext.Component   The newly instantiated Component.
 
each( Object fn, Object scope ) : Void
Executes the specified function once for each item in the collection. Returning false from the function will cease it...
Executes the specified function once for each item in the collection. Returning false from the function will cease iteration. The paramaters passed to the function are:
  • key : String

    The key of the item

  • value : Number

    The value of the item

  • length : Number

    The total number of items in the collection

Parameters

  • fn : Object
    The function to execute.
  • scope : Object
    The scope to execute in. Defaults to this.

Returns

  • Void
 
get( String id ) : Ext.Component
Returns a component by id. For additional details see Ext.util.MixedCollection.get.
Returns a component by id. For additional details see Ext.util.MixedCollection.get.

Parameters

  • id : String
    The component id

Returns

  • Ext.Component   The Component, undefined if not found, or null if a Class was found.
 
getCount : Number
Gets the number of items in the collection.
Gets the number of items in the collection.
 
isRegistered( Ext.Component xtype ) : Boolean
Checks if a Component type is registered.
Checks if a Component type is registered.

Parameters

  • xtype : Ext.Component
    The mnemonic string by which the Component class may be looked up

Returns

  • Boolean   Whether the type is registered.
 
onAvailable( String id, Function fn, Object scope ) : Void
Registers a function that will be called when a Component with the specified id is added to the manager. This will ha...
Registers a function that will be called when a Component with the specified id is added to the manager. This will happen on instantiation.

Parameters

  • id : String
    The component id
  • fn : Function
    The callback function
  • scope : Object
    The scope (this reference) in which the callback is executed. Defaults to the Component.

Returns

  • Void
 
register( Mixed item ) : Void
Registers an item to be managed
Registers an item to be managed

Parameters

  • item : Mixed
    The item to register

Returns

  • Void
 
registerType( String xtype, Constructor cls ) : Void
Registers a new Component constructor, keyed by a new Ext.Component.xtype. Use this method (or its alias Ext.reg) to ...

Registers a new Component constructor, keyed by a new Ext.Component.xtype.

Use this method (or its alias Ext.reg) to register new subclasses of Ext.Component so that lazy instantiation may be used when specifying child Components. see Ext.container.Container.items

Parameters

  • xtype : String
    The mnemonic string by which the Component class may be looked up.
  • cls : Constructor
    The new Component class.

Returns

  • Void
 
unregister( Mixed item ) : Void
Unregisters a component by removing it from this manager
Unregisters a component by removing it from this manager

Parameters

  • item : Mixed
    The item to unregister

Returns

  • Void
© 2011 Sencha Inc.