com.sencha.gxt.widget.core.client

Class ComponentManager

java.lang.Object

com.sencha.gxt.widget.core.client.ComponentManager

All Implemented Interfaces:

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

public class ComponentManager
extends Object
implements RegisterEvent.HasRegisterHandlers<Component>, UnregisterEvent.HasUnregisterHandlers<Component>

Provides a registry of all attached Component. Components automatically register and unregister with the widget manager when they are attached and detached.

Attaching and detaching are parts of the GWT widget lifecycle. Basically, widgets are attached when they become part of the DOM and then detached when removed from the DOM.

Events:

RegisterEvent

UnregisterEvent

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addRegisterHandler(RegisterEvent.RegisterHandler<Component> handler) Adds a RegisterEvent handler.
HandlerRegistration	addUnregisterHandler(UnregisterEvent.UnregisterHandler<Component> handler) Adds a UnregisterEvent handler.
<X extends Component> X	find(Element target) Attempts to find a widget.
<X extends Component> X	find(Element target, Class<X> clazz) Attempts to find a widget.
static ComponentManager	get() Returns the widget manager instance.
<X extends Component> List<X>	get(Class<?> clazz) Returns all widget by class.
Component	get(String id) Returns a widget by id.
Collection<Component>	getAll() Returns a collection of all registered components.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static ComponentManager get()

Returns the widget manager instance.

Returns:

the widget manager

addRegisterHandler

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

Description copied from interface: RegisterEvent.HasRegisterHandlers

Adds a RegisterEvent handler.

Specified by:

addRegisterHandler in interface RegisterEvent.HasRegisterHandlers<Component>

Parameters:

handler - the handler

Returns:

the registration for the event

addUnregisterHandler

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

Description copied from interface: UnregisterEvent.HasUnregisterHandlers

Adds a UnregisterEvent handler.

Specified by:

addUnregisterHandler in interface UnregisterEvent.HasUnregisterHandlers<Component>

Parameters:

handler - the handler

Returns:

the registration for the event

find

public <X extends Component> X find(Element target)

Attempts to find a widget.

Parameters:

target - the element or inner element of the widget

Returns:

the matching widget or null if no match

find

public <X extends Component> X find(Element target,
                           Class<X> clazz)

Attempts to find a widget.

Parameters:

target - the element or inner element of the widget

clazz - the class the widget should have

Returns:

the matching widget or null if no match

get

public <X extends Component> List<X> get(Class<?> clazz)

Returns all widget by class.

Parameters:

clazz - the class to match

Returns:

the list of matching components

get

public Component get(String id)

Returns a widget by id.

Parameters:

id - the widget id

Returns:

the widget or null if no match

getAll

public Collection<Component> getAll()

Returns a collection of all registered components.

Returns:

the collection of components