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

Interface UiWidgetFactory

All Superinterfaces:

AbstractUiWidgetFactoryDatatype, AbstractUiWidgetFactoryNative

All Known Implementing Classes:

AbstractUiWidgetFactory, UiWidgetFactoryImpl

@ComponentSpecification
public interface UiWidgetFactory
extends AbstractUiWidgetFactoryNative, AbstractUiWidgetFactoryDatatype

This interface is the central API for the end-user to create widgets via factory. The key to get started is the UiContext that gives access to this UiWidgetFactory via UiContext.getWidgetFactory().
Besides fabrication there are also custom widgets at a higher level - see net.sf.mmm.client.ui.base.widget.custom.UiWidgetCustom for details.
While UiWidgetFactoryNative allows to create any UiWidget via a generic and stable API this interface defines a higher-level factory that offers more comfort. So UiWidgetFactoryNative is the low-level factory to abstract from the underlying implementation this factory is the higher-level API for end-users and is implemented independent from the UI toolkit.
For generic access you can do:

 UiWidgetButton saveButton = factory.create(UiWidgetButton.class);
 saveButton.setLabel("save");
 saveButton.addClickHandler(clickHandler);
 

However, it is a more comfortable to do:

 UiWidgetButton saveButton = factory.createButton("save", clickHandler);
 

But you maybe also want to have a icon and a tooltip and NLS/I18N. And you discover that you do not only need this code once in your application but all over the place. Then you will be happy to see that you get all the comfort this way:

 UiHandlerActionSave saveHandler = ...;
 UiWidgetButton saveButton = factory.createButton(saveHandler);
 

Now this is just the beginning of this awesome UI framework. You will discover that there are even much higher level features such as e.g. the editor pattern. So see net.sf.mmm.client.ui.base.widget.custom.pattern.UiWidgetCustomEditor for more. ATTENTION:
This is a extendable interface.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDI_NAME The CDI name.

Method Summary

Modifier and Type	Method and Description
<HANDLER extends UiHandlerAction> UiWidgetButton	createButton(Class<HANDLER> handlerType, HANDLER handler) This method creates a new UiWidgetButton for the given UiHandlerAction.
<HANDLER extends UiHandlerAction> UiWidgetButton	createButton(Class<HANDLER> handlerType, HANDLER handler, boolean preventConfirmationPopup) This method creates a new UiWidgetButton for the given UiHandlerAction.
UiWidgetButton	createButton(String label, UiHandlerEventClick clickHandler) This method creates a new UiWidgetButton.
UiWidgetButton	createButton(UiHandlerAction handler) This method creates a new UiWidgetButton for the given UiHandlerAction.
<VALUE> UiWidgetComboboxField<VALUE>	createComboBox(String label, EnumDefinition<VALUE,?> enumDefinition) This method creates a new UiWidgetComboboxField.
<VALUE> UiWidgetComboboxField<VALUE>	createComboBox(String label, List<VALUE> options) This method creates a new UiWidgetComboboxField.
UiWidgetImage	createImage(String url, String altText) This method creates a new UiWidgetImage.
UiWidgetIntegerField	createIntegerField(String label) This method creates a new UiWidgetIntegerField.
UiWidgetLabel	createLabel(String label) This method creates a new UiWidgetLabel.
<ROW> UiWidgetListTable<ROW>	createListTable(Class<ROW> rowType) Creates a new UiWidgetListTable for the given rowType.
UiWidgetLongField	createLongField(String label) This method creates a new UiWidgetLongField.
UiWidgetPopup	createPopup(String title) Creates a new UiWidgetPopup.
UiWidgetPopup	createPopup(String title, boolean closable, boolean resizable, boolean movable) Creates a new UiWidgetPopup.
UiWidgetSection	createSection(String label) This method creates a new UiWidgetSection.
UiWidgetSplitPanel	createSplitPanel(Orientation orientation, UiWidgetRegular... children) Creates a new UiWidgetSplitPanel.
UiWidgetTextAreaField	createTextAreaField(String label) This method creates a new UiWidgetTextAreaField.
UiWidgetTextField	createTextField(String label) This method creates a new UiWidgetTextField.
<NODE> UiWidgetTree<NODE>	createTree(UiWidgetAbstractTree.UiTreeModel<NODE> model, String title) Creates a new UiWidgetTree for the given model.

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

create, getMainWindow, getNativeWidget

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

createForDatatype

Field Detail

CDI_NAME

static final String CDI_NAME

The CDI name.

See Also:

Constant Field Values

Method Detail

createButton

UiWidgetButton createButton(String label,
                            UiHandlerEventClick clickHandler)

This method creates a new UiWidgetButton.

Parameters:

label - is the label.

clickHandler - is the UiHandlerEventClick invoked if the button is clicked.

Returns:

the new widget instance.

See Also:

createButton(UiHandlerAction)

createButton

UiWidgetButton createButton(UiHandlerAction handler)

This method creates a new UiWidgetButton for the given UiHandlerAction. E.g. passing an instance of UiHandlerActionSave will create a save-button that invokes UiHandlerActionSave.onSave(net.sf.mmm.client.ui.api.event.UiEvent) if clicked.
ATTENTION:
This method will fail with an exception if the given handler implements more than one known UiHandlerAction interface. Use createButton(Class, UiHandlerAction) to prevent this.

Parameters:

handler - is the UiHandlerAction instance.

Returns:

the new widget instance.

createButton

<HANDLER extends UiHandlerAction> UiWidgetButton createButton(Class<HANDLER> handlerType,
                                                              HANDLER handler)

This method creates a new UiWidgetButton for the given UiHandlerAction. In advance to createButton(UiHandlerAction) this method can be used for an handler implementation that realizes multiple UiHandlerAction interfaces as the proper one to choose is identified by handlerType.

Type Parameters:

HANDLER - is the generic type of the UiHandlerAction.

Parameters:

handlerType - is the Class reflecting the UiHandlerAction interface to create a button for.

handler - is the UiHandlerAction instance.

Returns:

the new widget instance.

createButton

<HANDLER extends UiHandlerAction> UiWidgetButton createButton(Class<HANDLER> handlerType,
                                                              HANDLER handler,
                                                              boolean preventConfirmationPopup)

This method creates a new UiWidgetButton for the given UiHandlerAction. In advance to createButton(UiHandlerAction) this method can be used for an handler implementation that realizes multiple UiHandlerAction interfaces as the proper one to choose is identified by handlerType.

Type Parameters:

HANDLER - is the generic type of the UiHandlerAction.

Parameters:

handlerType - is the Class reflecting the UiHandlerAction interface to create a button for.

handler - is the UiHandlerAction instance.

preventConfirmationPopup - - some plain handlers represent operations like UiHandlerActionDelete.onDelete(net.sf.mmm.client.ui.api.event.UiEvent) that should be confirmed by the user to prevent accidental invocations. In such case the returned UiWidgetButton will by itself open a confirmation popup allowing to cancel to operation. This will make your life easier. However, if you want to customize the popup with contextual information (e.g. "Are you sure you want to delete the 23 selected documents?") you can implement that inside the given handler and prevent the default popup by providing true here. Use false for the default behavior.

Returns:

the new widget instance.

createLabel

UiWidgetLabel createLabel(String label)

This method creates a new UiWidgetLabel.

Parameters:

label - is the label.

Returns:

the new widget instance.

createSection

UiWidgetSection createSection(String label)

This method creates a new UiWidgetSection.

Parameters:

label - is the label.

Returns:

the new widget instance.

createImage

UiWidgetImage createImage(String url,
                          String altText)

This method creates a new UiWidgetImage.

Parameters:

url - is the URL.

altText - is the alternative text.

Returns:

the new widget instance.

createTextField

UiWidgetTextField createTextField(String label)

This method creates a new UiWidgetTextField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createTextAreaField

UiWidgetTextAreaField createTextAreaField(String label)

This method creates a new UiWidgetTextAreaField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createIntegerField

UiWidgetIntegerField createIntegerField(String label)

This method creates a new UiWidgetIntegerField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createLongField

UiWidgetLongField createLongField(String label)

This method creates a new UiWidgetLongField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createComboBox

<VALUE> UiWidgetComboboxField<VALUE> createComboBox(String label,
                                                    List<VALUE> options)

This method creates a new UiWidgetComboboxField.

Type Parameters:

VALUE - is the generic type of the available selection options.

Parameters:

label - is the label.

options - are the options of the combobox. E.g. enum values via Arrays.asList(MyEnum.values()).

Returns:

the new widget instance.

createComboBox

<VALUE> UiWidgetComboboxField<VALUE> createComboBox(String label,
                                                    EnumDefinition<VALUE,?> enumDefinition)

This method creates a new UiWidgetComboboxField.

Type Parameters:

VALUE - is the generic type of the available selection options.

Parameters:

label - is the label.

enumDefinition - is the EnumDefinition identifying the available options. These may be loaded asynchronous via EnumProvider.

Returns:

the new widget instance.

createTree

<NODE> UiWidgetTree<NODE> createTree(UiWidgetAbstractTree.UiTreeModel<NODE> model,
                                     String title)

Creates a new UiWidgetTree for the given model.

Type Parameters:

NODE - is the generic type of the tree nodes.

Parameters:

model - is the UiWidgetAbstractTree.UiTreeModel.

title - is the title of the tree. See also AttributeReadTitleVisible.isTitleVisible().

Returns:

the new widget instance.

createListTable

<ROW> UiWidgetListTable<ROW> createListTable(Class<ROW> rowType)

Creates a new UiWidgetListTable for the given rowType.

Type Parameters:

ROW - is the generic type of rowType.

Parameters:

rowType - is the Class reflecting a row in the value list.

Returns:

the new widget instance.

createSplitPanel

UiWidgetSplitPanel createSplitPanel(Orientation orientation,
                                    UiWidgetRegular... children)

Creates a new UiWidgetSplitPanel.

Parameters:

orientation - - Orientation.HORIZONTAL for UiWidgetHorizontalSplitPanel or Orientation.VERTICAL for UiWidgetVerticalSplitPanel.

children - are the children. You need to provide at least two children.

Returns:

the new widget instance.

createPopup

UiWidgetPopup createPopup(String title)

Creates a new UiWidgetPopup.

Parameters:

title - is the title.

Returns:

the new widget instance.

createPopup

UiWidgetPopup createPopup(String title,
                          boolean closable,
                          boolean resizable,
                          boolean movable)

Creates a new UiWidgetPopup.

Parameters:

title - is the title.

closable - is the value of AttributeReadClosable.isClosable().

resizable - is the value of AttributeReadResizable.isResizable().

movable - is the value of AttributeReadMovable.isMovable().

Returns:

the new widget instance.