com.gwtplatform.mvp.client

Class HandlerContainerImpl

java.lang.Object

com.gwtplatform.mvp.client.HandlerContainerImpl

All Implemented Interfaces:

HandlerContainer

Direct Known Subclasses:

PresenterWidget

public class HandlerContainerImpl
extends Object
implements HandlerContainer

The implementation of HandlerContainer. Inherit from this class if you want subclasses that can contain handlers.

Classes inheriting from HandlerContainerImpl and that participate in dependency injection with Guice/GIN can use the automatic binding mechanism. See HandlerContainerImpl() and HandlerContainerImpl(boolean) for more details.

Constructor Summary

Constructors

Constructor and Description
HandlerContainerImpl() Creates a handler container class with automatic binding, unless AutobindDisable is used to globally disable automatic binding.
HandlerContainerImpl(boolean autoBind) Creates a handler container class with or without automatic binding.

Method Summary

Methods

Modifier and Type	Method and Description
void	bind() Call this method after the object is constructed in order to bind all its handlers.
boolean	isBound() Returns true if the HandlerContainer is currently bound.
protected void	onBind() Lifecycle method called when binding the object.
protected void	onUnbind() Lifecycle method called when unbinding the object.
protected void	registerHandler(HandlerRegistration handlerRegistration) Registers a handler so that it is automatically removed when unbind() is called.
void	unbind() Call this method when you want to release the object and its handlers are not needed anymore.

Methods inherited from class java.lang.Object

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

Constructor Detail

HandlerContainerImpl

@Inject
public HandlerContainerImpl()

Creates a handler container class with automatic binding, unless AutobindDisable is used to globally disable automatic binding.

Autobinding requires the class to be instantiated by Guice/GIN. If you are instantiating HandlerContainerImpl with new, autobinding will not work. It is recommended you document it by using #HandlerContainerImpl(boolean) with false as a parameter.

HandlerContainerImpl

public HandlerContainerImpl(boolean autoBind)

Creates a handler container class with or without automatic binding. If automatic binding is requested, the bind() method will be called automatically after the class is instantiated through Guice/GIN dependency injection mechanism, unless AutobindDisable is used to globally disable automatic binding. Otherwise, the user is responsible for calling bind().

Autobinding requires the class to be instantiated by Guice/GIN. If you are instantiating HandlerContainerImpl with new, autobinding will not work. It is recommended you document it by passing false to the autoBind parameter.

Parameters:

autoBind - true to request automatic binding, false otherwise.

See Also:

HandlerContainerImpl()

Method Detail

bind

public void bind()

Description copied from interface: HandlerContainer

Call this method after the object is constructed in order to bind all its handlers. You should never call HandlerContainer.bind() from the constructor of a non-leaf class since it is meant to be called after the object has been entirely constructed.

When automatic binding is used (see HandlerContainerImpl), this will be called immediately after the object is constructed through Guice/GIN dependency injection mechanism.

If you are not using automatic binding, or if you later call HandlerContainer.unbind() on this object, you will have to call HandlerContainer.bind() manually.

Multiple call to bind will not fail, the class will be bound once.

Specified by:

bind in interface HandlerContainer

isBound

public final boolean isBound()

Description copied from interface: HandlerContainer

Returns true if the HandlerContainer is currently bound. That is, the HandlerContainer.bind() method has completed and HandlerContainer.unbind() has not been called.

Specified by:

isBound in interface HandlerContainer

Returns:

true if bound, false otherwise.

unbind

public void unbind()

Description copied from interface: HandlerContainer

Call this method when you want to release the object and its handlers are not needed anymore. You will have to call HandlerContainer.bind() again manually if you ever want to reuse the object.

Specified by:

unbind in interface HandlerContainer

onBind

protected void onBind()

Lifecycle method called when binding the object.

Important : Make sure you call your parent class onBind(). Also, do not call directly, call bind() instead.

Any event handler should be initialised here rather than in the constructor. Also, it is good practice to perform any costly initialisation here.

Handlers registered by calling registerHandler(HandlerRegistration) will be removed when unbinding. Any other initialisation that takes place here (or as a side-effect of what is done here) should be taken down in onUnbind().

This method will never be invoked more then once, or if it is, the second time will necessarily be preceded by an invocation of onUnbind().

onUnbind

protected void onUnbind()

Lifecycle method called when unbinding the object.

Important : Make sure you call your parent class onUnbind(). Also, do not call directly, call unbind() instead.

Any handler registration recorded with (HandlerRegistration) will have already been removed at this point. You should override this method to take down any other initialisation that took place in onBind().

This method will never be invoked more then once, or if it is, the second time will necessarily be preceded by an invocation of onBind().

registerHandler

protected void registerHandler(HandlerRegistration handlerRegistration)

Registers a handler so that it is automatically removed when unbind() is called. This provides an easy way to track event handler registrations.

Parameters:

handlerRegistration - The registration of handler to track.