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

Interface AbstractUiWidgetFactoryNative

All Known Subinterfaces:

UiWidgetFactory, UiWidgetFactoryNative

All Known Implementing Classes:

AbstractUiWidgetFactory, AbstractUiWidgetFactoryNative, UiWidgetFactoryImpl, UiWidgetFactoryNativeGwt, UiWidgetFactoryNativeTestImpl

public interface AbstractUiWidgetFactoryNative

This is the abstract interface for a factory used to create UiWidgets. You will typically use UiWidgetFactory that extends this interface.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

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).
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.

Method Detail

getMainWindow

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.

Returns:

the main window.

create

<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.

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

Object getNativeWidget(UiWidgetRegular widget)

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

Parameters:

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

Returns:

the native widget.