com.sencha.gxt.widget.core.client

Class WindowManager

java.lang.Object

com.sencha.gxt.widget.core.client.WindowManager

All Implemented Interfaces:

RegisterEvent.HasRegisterHandlers<Widget>, UnregisterEvent.HasUnregisterHandlers<Widget>

public class WindowManager
extends Object
implements RegisterEvent.HasRegisterHandlers<Widget>, UnregisterEvent.HasUnregisterHandlers<Widget>

An object that represents a group of Widget instances and provides z-order management and window activation behavior. By default, WindowManager only provides these features for the Window class, as Widgets don't have a concept of activation or moving to the front.

Can be extended and replaced to support non-Window classes - the main extension points will be the activateLast() and setActiveWin(Widget) methods, which should be made general enough for the specific use case. Then, the global WindowManager can be replaced with the subclass in the project module file:

 <replace-with class="com.example.project.client.ReplacementWindowManager">
     <when-type-is class="com.sencha.gxt.widget.core.client.WindowManager" />
 </replace-with>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessStack<Widget>	accessList
protected SimpleEventBus	eventBus
protected Widget	front
protected static WindowManager	instance
protected List<Widget>	widgets

Constructor Summary

Constructors

Constructor and Description
WindowManager() Creates a window manager.

Method Summary

Modifier and Type	Method and Description
protected void	activateLast() Activates the top window in the stack.
boolean	activateNext(Widget widget) Activates the next window in the access stack.
boolean	activatePrevious(Widget widget) Activates the previous widget in the access stack.
HandlerRegistration	addRegisterHandler(RegisterEvent.RegisterHandler<Widget> handler) Adds a RegisterEvent handler.
HandlerRegistration	addUnregisterHandler(UnregisterEvent.UnregisterHandler<Widget> handler) Adds a UnregisterEvent handler.
boolean	bringToFront(Widget widget) Brings the specified widget to the front of any other active widgets.
protected void	focus(Widget widget)
static WindowManager	get() Returns the singleton instance.
Widget	getActive() Gets the currently-active widget in the group.
Stack<Widget>	getStack() Returns the ordered widgets.
List<Widget>	getWindows() Returns the visible widgets.
void	hideAll() Hides all widgets that are registered to this WindowManager.
void	register(Widget widget) Registers the window with the WindowManager.
void	sendToBack(Widget widget) Sends the specified window to the back of other active widgets.
protected void	setActiveWin(Widget window) Indicates that this window should be made active.
void	unregister(Widget widget) Unregisters the window with the WindowManager.

Methods inherited from class java.lang.Object

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

Field Detail

instance

protected static WindowManager instance

accessList

protected AccessStack<Widget> accessList

front

protected Widget front

widgets

protected List<Widget> widgets

eventBus

protected SimpleEventBus eventBus

Constructor Detail

WindowManager

public WindowManager()

Creates a window manager.

Method Detail

get

public static WindowManager get()

Returns the singleton instance.

Returns:

the window manager

activateNext

public boolean activateNext(Widget widget)

Activates the next window in the access stack.

Parameters:

widget - the reference window

Returns:

true if the next window exists

activatePrevious

public boolean activatePrevious(Widget widget)

Activates the previous widget in the access stack.

Parameters:

widget - the reference window

Returns:

true if a previous window exists

addRegisterHandler

public HandlerRegistration addRegisterHandler(RegisterEvent.RegisterHandler<Widget> handler)

Description copied from interface: RegisterEvent.HasRegisterHandlers

Adds a RegisterEvent handler.

Specified by:

addRegisterHandler in interface RegisterEvent.HasRegisterHandlers<Widget>

Parameters:

handler - the handler

Returns:

the registration for the event

addUnregisterHandler

public HandlerRegistration addUnregisterHandler(UnregisterEvent.UnregisterHandler<Widget> handler)

Description copied from interface: UnregisterEvent.HasUnregisterHandlers

Adds a UnregisterEvent handler.

Specified by:

addUnregisterHandler in interface UnregisterEvent.HasUnregisterHandlers<Widget>

Parameters:

handler - the handler

Returns:

the registration for the event

bringToFront

public boolean bringToFront(Widget widget)

Brings the specified widget to the front of any other active widgets. Window instances will automatically call this method when focused, all other types must call manually.

Parameters:

widget - the window

Returns:

true if the widget was brought to the front, else false if it was already in front

getActive

public Widget getActive()

Gets the currently-active widget in the group.

Returns:

the active window

getStack

public Stack<Widget> getStack()

Returns the ordered widgets.

Returns:

the widgets

getWindows

public List<Widget> getWindows()

Returns the visible widgets.

Returns:

the widgets

hideAll

public void hideAll()

Hides all widgets that are registered to this WindowManager.

register

public void register(Widget widget)

Registers the window with the WindowManager. Window instances will automatically register and unregister themselves. All other types must register / unregister manually.

Parameters:

widget - the window

sendToBack

public void sendToBack(Widget widget)

Sends the specified window to the back of other active widgets.

Parameters:

widget - the widget

unregister

public void unregister(Widget widget)

Unregisters the window with the WindowManager.

Parameters:

widget - the widget

activateLast

protected void activateLast()

Activates the top window in the stack. Protected so it can be overridden to activate more than just GXT Window objects.

focus

protected void focus(Widget widget)

setActiveWin

protected void setActiveWin(Widget window)

Indicates that this window should be made active. Protected so it can be overridden to provide specialized behavior when more than GXT Windows are used.

Parameters:

window -