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

Class UiWidgetFactoryImpl

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

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

All Implemented Interfaces:

AbstractUiWidgetFactoryDatatype, AbstractUiWidgetFactoryNative, UiWidgetFactory

@Named(value="net.sf.mmm.client.ui.api.widget.UiWidgetFactoryAdvanced")
public class UiWidgetFactoryImpl
extends AbstractUiWidgetFactory

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 NlsBundleClientUiRoot	clientUiBundle
private EnumProvider	enumProvider
private Map<Class<? extends UiHandlerAction>,UiSingleWidgetButtonFactory<?>>	handlerType2ButtonFactoryMap

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

CDI_NAME

Constructor Summary

Constructors

Constructor and Description
UiWidgetFactoryImpl() The constructor.

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.
protected void	doInitialize() This method performs the actual initialization.
protected NlsBundleClientUiRoot	getClientUiBundle()
protected EnumProvider	getEnumProvider()
protected void	registerButtonFactories() This method registers all available button-factories.
protected void	registerButtonFactory(UiSingleWidgetButtonFactory<?> factory) Registers the given factory.
void	setEnumProvider(EnumProvider enumProvider)

Methods inherited from class net.sf.mmm.client.ui.base.widget.factory.AbstractUiWidgetFactory

create, createForDatatype, getContext, getMainWindow, getNativeWidget, setContext, setWidgetFactoryDatatype, setWidgetFactoryNative

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

Field Detail

enumProvider

private EnumProvider enumProvider

See Also:

getEnumProvider()

clientUiBundle

private NlsBundleClientUiRoot clientUiBundle

See Also:

getClientUiBundle()

handlerType2ButtonFactoryMap

private Map<Class<? extends UiHandlerAction>,UiSingleWidgetButtonFactory<?>> handlerType2ButtonFactoryMap

See Also:

createButton(Class, UiHandlerAction, boolean)

Constructor Detail

UiWidgetFactoryImpl

public UiWidgetFactoryImpl()

The constructor.

Method Detail

registerButtonFactory

protected void registerButtonFactory(UiSingleWidgetButtonFactory<?> factory)

Registers the given factory.

Parameters:

factory - is the UiSingleWidgetButtonFactory to register.

registerButtonFactories

protected void registerButtonFactories()

This method registers all available button-factories.

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 AbstractUiWidgetFactory

getEnumProvider

protected EnumProvider getEnumProvider()

Returns:

the enumProvider

setEnumProvider

@Inject
public void setEnumProvider(EnumProvider enumProvider)

Parameters:

enumProvider - is the enumProvider to set

getClientUiBundle

protected NlsBundleClientUiRoot getClientUiBundle()

Returns:

the instance of NlsBundleClientUiRoot.

createButton

public 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:

UiWidgetFactory.createButton(UiHandlerAction)

createButton

public 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 UiWidgetFactory.createButton(Class, UiHandlerAction) to prevent this.

Parameters:

handler - is the UiHandlerAction instance.

Returns:

the new widget instance.

createButton

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

This method creates a new UiWidgetButton for the given UiHandlerAction. In advance to UiWidgetFactory.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

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

createImage

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

createLabel

public UiWidgetLabel createLabel(String label)

This method creates a new UiWidgetLabel.

Parameters:

label - is the label.

Returns:

the new widget instance.

createSection

public UiWidgetSection createSection(String label)

This method creates a new UiWidgetSection.

Parameters:

label - is the label.

Returns:

the new widget instance.

createTextField

public UiWidgetTextField createTextField(String label)

This method creates a new UiWidgetTextField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createTextAreaField

public UiWidgetTextAreaField createTextAreaField(String label)

This method creates a new UiWidgetTextAreaField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createIntegerField

public UiWidgetIntegerField createIntegerField(String label)

This method creates a new UiWidgetIntegerField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createLongField

public UiWidgetLongField createLongField(String label)

This method creates a new UiWidgetLongField.

Parameters:

label - is the label.

Returns:

the new widget instance.

createComboBox

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

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

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

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

public 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

public UiWidgetPopup createPopup(String title)

Creates a new UiWidgetPopup.

Parameters:

title - is the title.

Returns:

the new widget instance.

createPopup

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