net.sf.mmm.client.ui.base.widget

Class AbstractUiWidgetFactoryNative

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetFactoryNative

All Implemented Interfaces:

AbstractUiWidgetFactoryNative, UiWidgetFactoryNative

Direct Known Subclasses:

UiWidgetFactoryNativeGwt, UiWidgetFactoryNativeTestImpl

public abstract class AbstractUiWidgetFactoryNative
extends AbstractComponent
implements UiWidgetFactoryNative

This is the abstract base implementation of UiContext using UiSingleWidgetFactoryNative. This is helpful for implementations that can NOT use reflection. Implementations extending this Class need to register instances of UiSingleWidgetFactoryNative for all supported types of UiWidgets.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private UiContext	context
private Map<Class<? extends UiWidgetNative>,UiSingleWidgetFactoryNative<?>>	interface2subFactoryMap
private UiWidgetMainWindow	mainWindow

Fields inherited from interface net.sf.mmm.client.ui.api.widget.factory.UiWidgetFactoryNative

CDI_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetFactoryNative() The constructor.

Method Summary

Modifier and Type	Method and Description
<WIDGET extends UiWidgetNative> WIDGET	create(Class<WIDGET> widgetInterface) This method creates a new UiWidget instance of the given type ( widgetInterface).
protected abstract UiWidgetMainWindow	createMainWindow()
UiContext	getContext()
UiWidgetMainWindow	getMainWindow() This method gets the application main window.
Object	getNativeWidget(UiWidgetRegular widget) This method gets the underlying native widget of the given regular widget.
protected void	register(UiSingleWidgetFactoryNative<?> subFactory) This method registers the given UiSingleWidgetFactoryNative as sub-factory of this factory.
void	setContext(UiContext context)

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialize, doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

interface2subFactoryMap

private final Map<Class<? extends UiWidgetNative>,UiSingleWidgetFactoryNative<?>> interface2subFactoryMap

See Also:

create(Class)

context

private UiContext context

See Also:

getContext()

mainWindow

private UiWidgetMainWindow mainWindow

See Also:

getMainWindow()

Constructor Detail

AbstractUiWidgetFactoryNative

public AbstractUiWidgetFactoryNative()

The constructor.

Method Detail

getContext

public UiContext getContext()

Returns:

the instance of UiContext.

setContext

@Inject
public void setContext(UiContext context)

Parameters:

context - is the instance of UiContext to Inject

register

protected void register(UiSingleWidgetFactoryNative<?> subFactory)

This method registers the given UiSingleWidgetFactoryNative as sub-factory of this factory.

Parameters:

subFactory - is the UiSingleWidgetFactoryNative to register.

create

public <WIDGET extends UiWidgetNative> WIDGET create(Class<WIDGET> widgetInterface)

This method creates a new UiWidget instance of the given type ( widgetInterface).
IMPORTANT:
When creating a large (enterprise) application client you should NOT (directly) use this method to create field widgets such as UiWidgetLocalDateField or UiWidgetTextField. Instead use UiWidgetFactoryDatatype.createForDatatype(Class).
ATTENTION:
The API of UiWidget defines base interfaces marks as abstract. These interfaces cannot be used as argument to this method. Further some widget interfaces are NOT abstract but will not be created via this method but from some other widget. To avoid confusion the widgets that can be created here are marked via the interface UiWidgetNative. All these interfaces except for UiWidgetNative itself can be created and should be supported as legal arguments to this method.

Specified by:

create in interface AbstractUiWidgetFactoryNative

Type Parameters:

WIDGET - is the generic type of the UiWidget to create.

Parameters:

widgetInterface - is the interface reflecting the UiWidget to create. Must NOT be abstract.

Returns:

the new UiWidget.

getNativeWidget

public Object getNativeWidget(UiWidgetRegular widget)

This method gets the underlying native widget of the given regular widget.

Specified by:

getNativeWidget in interface AbstractUiWidgetFactoryNative

Parameters:

widget - is the regular widget to unwrap. It has to be an instance created by this factory.

Returns:

the native widget.

getMainWindow

public UiWidgetMainWindow getMainWindow()

This method gets the application main window. In case of a web application this will be the browser window (respective the current tab). In case of a MDI (multiple document interface) client this is the master window. Otherwise it will be a new window that should be opened initially.

Specified by:

getMainWindow in interface AbstractUiWidgetFactoryNative

Returns:

the main window.

createMainWindow

protected abstract UiWidgetMainWindow createMainWindow()

Returns:

a new instance of UiWidgetMainWindow for getMainWindow().