Sencha Documentation

Ext.ZIndexManager

Overview
Report a bug

A class that manages a group of Ext.Component-floating Components and provides z-order management, and Component activation behavior, including masking below the active (topmost) Component.

Floating Components which are rendered directly into the document (Such as Windows which are shown are managed by a global instance.

Floating Components which are descendants of floating Containers (For example a {Ext.view.BoundList BoundList} within an Window, or a Menu), are managed by a ZIndexManager owned by that floating Container. So ComboBox dropdowns within Windows will have managed z-indices guaranteed to be correct, relative to the Window.

Defined By

Methods

 
Ext.ZIndexManager
view source
bringToFront( String/Object comp) : Boolean
Brings the specified Component to the front of any other active Components in this ZIndexManager.
Brings the specified Component to the front of any other active Components in this ZIndexManager.

Parameters

  • comp : String/Object
    The id of the Component or a Ext.Component instance

Returns

  • Boolean   True if the dialog was brought to the front, else false if it was already in front
 
Ext.ZIndexManager
view source
each( Function fn, [Object scope]) : Void
Executes the specified function once for every Component in this ZIndexManager, passing each Component as the only pa...
Executes the specified function once for every Component in this ZIndexManager, passing each Component as the only parameter. Returning false from the function will stop the iteration.

Parameters

  • fn : Function
    The function to execute for each item
  • scope : Object
    (optional) The scope (this reference) in which the function is executed. Defaults to the current Component in the iteration.

Returns

  • Void
 
Ext.ZIndexManager
view source
get( String/Object id) : Ext.Component
Gets a registered Component by id.
Gets a registered Component by id.

Parameters

  • id : String/Object
    The id of the Component or a Ext.Component instance

Returns

  • Ext.Component
 
Ext.ZIndexManager
view source
getActive : Ext.Component
Gets the currently-active Component in this ZIndexManager.
Gets the currently-active Component in this ZIndexManager.

Returns

  • Ext.Component   The active Component
 
Ext.ZIndexManager
view source
getBy( Function fn, [Object scope]) : Array
Returns zero or more Components in this ZIndexManager using the custom search function passed to this method. The fun...
Returns zero or more Components in this ZIndexManager using the custom search function passed to this method. The function should accept a single Ext.Component reference as its only argument and should return true if the Component matches the search criteria, otherwise it should return false.

Parameters

  • fn : Function
    The search function
  • scope : Object
    (optional) The scope (this reference) in which the function is executed. Defaults to the Component being tested. that gets passed to the function if not specified)

Returns

  • Array   An array of zero or more matching windows
 
Ext.ZIndexManager
view source
hideAll : Void
Hides all Components managed by this ZIndexManager.
Hides all Components managed by this ZIndexManager.

Returns

  • Void
 
Ext.ZIndexManager
view source
register( Component comp) : Void
Registers a floating Ext.Component with this ZIndexManager. This should not need to be called under normal circumstan...

Registers a floating Ext.Component with this ZIndexManager. This should not need to be called under normal circumstances. Floating Components (such as Windows, BoundLists and Menus) are automatically registered with a zIndexManager at render time.

Where this may be useful is moving Windows between two ZIndexManagers. For example, to bring the Ext.MessageBox dialog under the same manager as the Desktop's ZIndexManager in the desktop sample app:

MyDesktop.getDesktop().getManager().register(Ext.MessageBox);

Parameters

  • comp : Component
    The Component to register.

Returns

  • Void
 
Ext.ZIndexManager
view source
sendToBack( String/Object comp) : Ext.Component
Sends the specified Component to the back of other active Components in this ZIndexManager.
Sends the specified Component to the back of other active Components in this ZIndexManager.

Parameters

  • comp : String/Object
    The id of the Component or a Ext.Component instance

Returns

  • Ext.Component   The Component
 
Ext.ZIndexManager
view source
unregister( Component comp) : Void
Unregisters a Ext.Component from this ZIndexManager. This should not need to be called. Components are automatically ...

Unregisters a Ext.Component from this ZIndexManager. This should not need to be called. Components are automatically unregistered upon destruction. See register.

Parameters

  • comp : Component
    The Component to unregister.

Returns

  • Void
© 2011 Sencha Inc.