Disc API

Object AsyncRequestOverlay

public singleton object AsyncRequestOverlay

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


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

getColor

public string getColor()

Reurns the current color setting for the overlay.

Returns:: string - The current color setting

getEnabled

public boolean getEnabled()

Returns the current 'enabled' property state for the overlay.

Returns:: boolean - The current 'enabled' property state

getOpacity

public number getOpacity()

Returns the current opacity setting for the overlay.

Returns:: number - The currently set opacity value for the overlay, ranging from 0.0 to 1.0

getZIndex

public number getZIndex()

Returns the current z-index setting for the overlay.

Returns:: number - The current z-index setting

on

public void on(name, listener)

This method allows listeners to be added to supported events. Supported event names include:

"shown": Fired when the overlay is shown to the user during an async request
"hidden": Fired when the overlay is hidden from view after the request completes

Parameters:: 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 fired
See Also:: bea.wlp.disc.xie.AsyncRequestOverlay.un

setColor

public void setColor(color)

Allows the color of the overlay to be set. By default, the overlay color is configured to "#000" (black). Valid values include anything accepted/recognized by CSS color properties. Examples include "#ffffff" or "white".

Parameters:: string color - A valid CSS color value

setEnabled

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. Setting the 'enabled' property to 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.

Parameters:: boolean enabled - True if this overlay system should be enabled; false otherwise

setOpacity

public void setOpacity(opacity)

Allows the opacity of the overlay to be set. By default, the overlay is configured to be completely transparent (i.e. set to a value of 0.0).

Parameters:: number opacity - A numeric value ranging from 0.0 to 1.0

setZIndex

public void setZIndex(zIndex)

Allows the z-index of the overlay to be configured. By default, a value of 9000 is used.

Parameters:: number zIndex - The z-index setting for the overlay

un

public void un(name, listener)

Removes a listener from one of the overlay's events that was added via the on method.

Parameters:: 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 succeed
See Also:: bea.wlp.disc.xie.AsyncRequestOverlay.on