asquare.gwt.tk.client.ui
Class CWrapper

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Composite
              asquare.gwt.tk.client.ui.EventWrapper
                  asquare.gwt.tk.client.ui.CWrapper

All Implemented Interfaces:

ControllerSupport, EventListener

public class CWrapper
extends EventWrapper
implements ControllerSupport

Wraps an widget to provide event processing via controllers. The wrapped widget will process events and notify listeners as if it was not wrapped.

Constructor Summary

CWrapper(Widget widget)
Creates a CWrapper around the specified widget.

CWrapper(Widget widget, List controllers)
Creates a CWrapper around the specified widget.

Method Summary

Widget	addController(Controller controller) Adds a controller to process events on this widget.
protected List	createControllers() A factory method which gives subclasses the opportunity to override default controller creation.
Controller	getController(Class id) Gets a controller with the specified id.
protected void	onAttach()
void	onBrowserEvent(Event event) Override to process browser events.
protected void	onDetach()
protected void	onLoad()
protected void	onUnload() This method is called just before the widget is detached from the browser's document.
Widget	removeController(Controller controller) Removes a controller
void	setControllers(List controllers) Sets the controllers which will process events on this widget.
void	sinkEvents(int eventBits)
void	unsinkEvents(int eventBits)

Methods inherited from class asquare.gwt.tk.client.ui.EventWrapper

getWidget, initWidget

Methods inherited from class com.google.gwt.user.client.ui.Composite

getElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

getParent, isAttached, removeFromParent

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleName, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getTitle, isVisible, isVisible, removeStyleName, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setTitle, setVisible, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CWrapper

public CWrapper(Widget widget)

Creates a CWrapper around the specified widget.

CWrapper

public CWrapper(Widget widget,
                List controllers)

Creates a CWrapper around the specified widget. Pass a value for controllers if you wish to avoid controller creation via createControllers(). Otherwise pass null.

Parameters:

controllers - a list of 0 or more controllers, or null

Throws:

IllegalArgumentException - if element is null

Method Detail

createControllers

protected List createControllers()

A factory method which gives subclasses the opportunity to override default controller creation.

Returns:

a List with 0 or more controllers, or null

getController

public Controller getController(Class id)

Description copied from interface: ControllerSupport

Gets a controller with the specified id. The id is often an interface or base class, as controllers can have multiple implementations. Used to modify the behavior of existing widgets.

Specified by:

getController in interface ControllerSupport

Parameters:

id - a Class identifying the type of controller to get

Returns:

the first controller matching the id, or null

addController

public Widget addController(Controller controller)

Description copied from interface: ControllerSupport

Adds a controller to process events on this widget. Multiple controllers may be added.

Specified by:

addController in interface ControllerSupport

Parameters:

controller - a controller to add

Returns:

the widget this call was made on (for convenience)

removeController

public Widget removeController(Controller controller)

Description copied from interface: ControllerSupport

Removes a controller

Specified by:

removeController in interface ControllerSupport

Parameters:

controller - a controller to remove

Returns:

the widget this call was made on (for convenience)

setControllers

public void setControllers(List controllers)

Description copied from interface: ControllerSupport

Sets the controllers which will process events on this widget. Clears out the current controllers, if any. When the widget is added to the DOM, received events will be delegated to each controller which declares the event's type via getEventBits().

Specified by:

setControllers in interface ControllerSupport

Parameters:

controllers - a list of 0 or more controllers, or null

sinkEvents

public void sinkEvents(int eventBits)

Overrides:

sinkEvents in class UIObject

unsinkEvents

public void unsinkEvents(int eventBits)

Overrides:

unsinkEvents in class UIObject

onAttach

protected void onAttach()

Overrides:

onAttach in class EventWrapper

onDetach

protected void onDetach()

Overrides:

onDetach in class Composite

onLoad

protected void onLoad()

Overrides:

onLoad in class Widget

onUnload

protected void onUnload()

This method is called just before the widget is detached from the browser's document.

onBrowserEvent

public void onBrowserEvent(Event event)

Description copied from class: EventWrapper

Override to process browser events. Don't forget to call super implementation if you want the wrapped widget to process events also.

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class EventWrapper