org.sgx.j2s.yui3.yui
Class OverlayManager

java.lang.Object
  org.sgx.j2s.js.NativeWrapper
      org.sgx.j2s.yui3.yui.YUINativeWrapper
          org.sgx.j2s.yui3.yui.event.EventTarget
              org.sgx.j2s.yui3.yui.Attribute
                  org.sgx.j2s.yui3.yui.Base
                      org.sgx.j2s.yui3.yui.OverlayManager

Direct Known Subclasses:

DialogManager

public class OverlayManager
extends Base

A base class for OverlayManager, providing:
Grouping overlays
Show or hide the entire group of registered overlays
Basic Overlay Stackability (zIndex support)
Quick Example:

var groupOverlayManager = new A.OverlayManager();
groupOverlayManager.register([overlay1, overlay2, overlay3]);
groupOverlayManager.hideAll();

Field Summary

Fields inherited from class org.sgx.j2s.yui3.yui.YUINativeWrapper

Y

Fields inherited from class org.sgx.j2s.js.NativeWrapper

_data, _EMPTYPARAMS

Constructor Summary

OverlayManager()

Method Summary

void	bringToTop(Overlay overlay) Set the passed overlay zIndex to the highest value.
void	each(java.lang.Runnable fn) Loop through all registered Overlay and execute a callback.
int	getZIndexBase() get The zIndex base to be used on the stacking for all overlays registered on the OverlayManager.
void	hideAll() Invoke the hide method from all registered Overlays.
void	register(Overlay overlay) Register the passed Overlay to this OverlayManager.
void	remove(Overlay overlay) remove the passed Overlay to this OverlayManager.
void	setZIndexBase(int zIndex) sets The zIndex base to be used on the stacking for all overlays registered on the OverlayManager.
void	showAll() Invoke the show method from all registered Overlays.

Methods inherited from class org.sgx.j2s.yui3.yui.Attribute

addAttr, addAttrs, attrAdded, get, getAttrs, modifyAttr, removeAttr, reset, set, setAttrs

Methods inherited from class org.sgx.j2s.yui3.yui.event.EventTarget

after, before, detach, detachAll, fire, getEvent, on, once, publish

Methods inherited from class org.sgx.j2s.yui3.yui.YUINativeWrapper

_load

Methods inherited from class org.sgx.j2s.js.NativeWrapper

_call, _get, _getData, create

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverlayManager

public OverlayManager()

Method Detail

getZIndexBase

public int getZIndexBase()

get The zIndex base to be used on the stacking for all overlays registered on the OverlayManager.

setZIndexBase

public void setZIndexBase(int zIndex)

sets The zIndex base to be used on the stacking for all overlays registered on the OverlayManager.

bringToTop

public void bringToTop(Overlay overlay)

Set the passed overlay zIndex to the highest value.

Parameters:

overlay - Instance of Overlay.

each

public void each(java.lang.Runnable fn)

Loop through all registered Overlay and execute a callback.

Parameters:

fn - Callback to be executed on the Array.each

hideAll

public void hideAll()

Invoke the hide method from all registered Overlays.

register

public void register(Overlay overlay)

Register the passed Overlay to this OverlayManager.

Parameters:

overlay - Overlay instance to be registered

remove

public void remove(Overlay overlay)

remove the passed Overlay to this OverlayManager.

Parameters:

overlay - Overlay instance to be removed

showAll

public void showAll()

Invoke the show method from all registered Overlays.