This object represents the global asynchronous request overlay used to block UI input during asynchronous XIE interactions. The small public API available on this object allows for a significant degree of customization of the overlay, or even allows for the overlay to be suppressed for applications that either wish to provide their own blocking overlay implementation or simply don't need or want it to be employed.
Further customization of UI-blocking appearance and behavior during XIE requests can be achieved by listening for the overlay's "shown" and "hidden" events. Advanced behaviors such as wait animations or the display of additional UI during XIE requests are easily synchronized with the display of this object by observing these events.
Method Summary | |
public string
|
getColor()
Reurns the current color setting for the overlay. |
public boolean
|
getEnabled()
Returns the current 'enabled' property state for the overlay. |
public number
|
getOpacity()
Returns the current opacity setting for the overlay. |
public number
|
getZIndex()
Returns the current z-index setting for the overlay. |
public void
|
on(name, listener)
This method allows listeners to be added to supported events. |
public void
|
setColor(color)
Allows the color of the overlay to be set. |
public void
|
setEnabled(enabled)
Allows the application to control whether or not XIE's overlay system is employed for input blocking during asynchronous XIE requests. |
public void
|
setOpacity(opacity)
Allows the opacity of the overlay to be set. |
public void
|
setZIndex(zIndex)
Allows the z-index of the overlay to be configured. |
public void
|
un(name, listener)
Removes a listener from one of the overlay's events that was added via the on
method.
|
Method Detail |
public string getColor()
string
-
The current color settingpublic boolean getEnabled()
boolean
-
The current 'enabled' property statepublic number getOpacity()
number
-
The currently set opacity value for the overlay, ranging from 0.0 to 1.0public number getZIndex()
number
-
The current z-index settingpublic void on(name, listener)
string name
- The name of the event to listen to (either "shown" or "hidden")function listener
- The listener callback function to invoke when the event is firedpublic void setColor(color)
string color
- A valid CSS color valuepublic void setEnabled(enabled)
false
suppresses all
use of the overlay. Setting this property to false
will also cause the overlay to be
immediately hidden if it is currently showing.boolean enabled
- True if this overlay system should be enabled; false otherwisepublic void setOpacity(opacity)
number opacity
- A numeric value ranging from 0.0 to 1.0public void setZIndex(zIndex)
number zIndex
- The z-index setting for the overlaypublic void un(name, listener)
on
method.string name
- The name of the event being listened to (either "shown" or "hidden")function listener
- The listener callback to remove; must match a function passed to on
to succeedGenerated on Tue Aug 19 2008 09:38:26 GMT-0600 (MDT). | Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. |