X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.ZIndexManager.html diff --git a/docs/api/Ext.ZIndexManager.html b/docs/api/Ext.ZIndexManager.html new file mode 100644 index 00000000..8f251b38 --- /dev/null +++ b/docs/api/Ext.ZIndexManager.html @@ -0,0 +1,146 @@ +Ext.ZIndexManager | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

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

 

 

+

Returns

  • void    +
 
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

    +
 
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    +
 
eachBottomUp( +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. +The components are passed to the function starting at the bottom and proceeding to the top.

+

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    +
 
eachTopDown( +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. +The components are passed to the function starting at the top and proceeding to the bottom.

+

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    +
 
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    +
 

Gets the currently-active Component in this ZIndexManager.

+

Gets the currently-active Component in this ZIndexManager.

+

Returns

  • Ext.Component   

    The active Component

    +
 
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

    +
 

Hides all Components managed by this ZIndexManager.

+

Hides all Components managed by this ZIndexManager.

+

Returns

  • void    +
 
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    +
 
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

    +
 
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    +
\ No newline at end of file