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

Class AbstractUiWidgetFactory

java.lang.Object

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

net.sf.mmm.util.component.base.AbstractLoggableComponent

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

All Implemented Interfaces:

AbstractUiWidgetFactoryDatatype, AbstractUiWidgetFactoryNative, UiWidgetFactory

Direct Known Subclasses:

UiWidgetFactoryImpl

public abstract class AbstractUiWidgetFactory
extends AbstractLoggableComponent
implements UiWidgetFactory

This is the implementation of UiWidgetFactory.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractUiContext	context
private UiWidgetFactoryDatatype	widgetFactoryDatatype
private UiWidgetFactoryNative	widgetFactoryNative

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

CDI_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetFactory() 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).
<VALUE> UiWidgetField<VALUE>	createForDatatype(Class<VALUE> datatype) This method creates a new instance of the field widget to view and edit the given datatype.
protected void	doInitialize() This method performs the actual initialization.
protected 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.
void	setContext(AbstractUiContext context)
void	setWidgetFactoryDatatype(UiWidgetFactoryDatatype widgetFactoryDatatype)
void	setWidgetFactoryNative(UiWidgetFactoryNative widgetFactoryNative)

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

createLogger, getLogger

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

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetFactory

createButton, createButton, createButton, createButton, createComboBox, createComboBox, createImage, createIntegerField, createLabel, createListTable, createLongField, createPopup, createPopup, createSection, createSplitPanel, createTextAreaField, createTextField, createTree

Field Detail

context

private AbstractUiContext context

See Also:

getContext()

widgetFactoryNative

private UiWidgetFactoryNative widgetFactoryNative

See Also:

setWidgetFactoryNative(UiWidgetFactoryNative)

widgetFactoryDatatype

private UiWidgetFactoryDatatype widgetFactoryDatatype

See Also:

setWidgetFactoryDatatype(UiWidgetFactoryDatatype)

Constructor Detail

AbstractUiWidgetFactory

public AbstractUiWidgetFactory()

The constructor.

Method Detail

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

getContext

protected UiContext getContext()

Returns:

the UiContext instance.

setContext

@Inject
public void setContext(AbstractUiContext context)

Parameters:

context - is the UiContext to Inject.

setWidgetFactoryDatatype

@Inject
public void setWidgetFactoryDatatype(UiWidgetFactoryDatatype widgetFactoryDatatype)

Parameters:

widgetFactoryDatatype - is the UiWidgetFactoryDatatype to Inject.

setWidgetFactoryNative

@Inject
public void setWidgetFactoryNative(UiWidgetFactoryNative widgetFactoryNative)

Parameters:

widgetFactoryNative - is the UiWidgetFactoryNative to Inject.

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.

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.

createForDatatype

public <VALUE> UiWidgetField<VALUE> createForDatatype(Class<VALUE> datatype)

This method creates a new instance of the field widget to view and edit the given datatype.
NOTE:
Using this API is a key for creating a maintainable UI. Define custom datatypes (e.g. CustomerNumber) and use them in your data-model to make it more expressive. For each datatype you are using (including standard datatypes such as String as well as complex datatypes that require a composition of multiple widgets) you can register a sub-factory for each datatype and then consequently use this method in your presentation code to receive the proper field widget. The end-user will thank you for a consistent UI (where the CustomerNumber is viewed and edited in exactly the same way in each dialog). Also you can stay (a lot more) relaxed in case a change request comes up that CustomerNumber has to change its format and validation rules in the entire data-model and UI.

Specified by:

createForDatatype in interface AbstractUiWidgetFactoryDatatype

Type Parameters:

VALUE - is the generic type of the Datatype.

Parameters:

datatype - is the Datatype.

Returns:

the new field widget to display and edit the specified datatype.