com.whitestein.lsps.vaadin.ui

Class UIComponentFactoryImpl

java.lang.Object

com.whitestein.lsps.vaadin.ui.UIComponentFactoryImpl

All Implemented Interfaces:

UIComponentFactory, Serializable

public class UIComponentFactoryImpl
extends Object
implements UIComponentFactory, Serializable

Default implementation of UIComponentFactory which supports all standard components defined in lsps standard library.

Author:

mbj

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIComponentFactoryImpl.ScreenLevelRecord Creates image of validation error in screen-level context, which is seen by all UIComponents.

Field Summary

Fields

Modifier and Type	Field and Description
protected LspsAppConnector	connector Instance of LspsAppConnector
static boolean	DEBUG

Fields inherited from interface com.whitestein.lsps.vaadin.ui.UIComponentFactory

REQUIRED_STYLE_NAME

Constructor Summary

Constructors

Constructor and Description
UIComponentFactoryImpl(LspsAppConnector connector) Creates new instance with the given application connector.

Method Summary

Modifier and Type	Method and Description
void	addErrorMessagesToComponents(Map<UIComponent,List<String>> errorMessages) Default implementation simply uses UIComponents.addComponentError(com.whitestein.lsps.vaadin.ui.components.UIComponent, String) to attach error messages to Vaadin components.
void	afterCreate(UIComponent component) Perform standard set of behaviors when component is created.
void	applyCommonProperties(UIComponent component) Applies all standard properties from the component definition to the given input component.
protected void	applyHint(UIComponent component, String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies single hint of the given value to the given component
void	applyListeners(UIComponent component) Applies all listeners defined in the component definition associated with the given component.
protected UIComponent	createActionLink(UIComponentData componentData)
protected UIBrowserFrame	createBrowserFrame(UIComponentData componentData)
protected UIComponent	createButtonLink(UIComponentData componentData)
protected UICalendar	createCalendar(UIComponentData componentData)
protected UICartesianChart	createCartesianChart(UIComponentData componentData)
protected UIComponent	createCheckBox(UIComponentData componentData)
protected UIComponent	createCheckBoxList(UIComponentData componentData)
protected UIComponent	createComboBox(UIComponentData componentData)
UIComponent	createComponent(LspsScreen screen, UIComponent parent, RecordHolder componentDefinition, UIComponentScope scope) Creates and injects component based on the provided component definition.
protected UIComponent	createComponent(UIComponentData componentData) This method is responsible for creating a component based on the provided component data.
protected UIComponent	createConditional(UIComponentData componentData)
protected UIComponent	createContainer(UIComponentData componentData)
com.vaadin.data.util.converter.Converter<?,?>	createConverterForRenderer(UIGrid owner, Variant.RecordVariant rendererDef) Optionally a converter may be used together with a renderer, to convert LSPS types to Java objects as expected by the renderer.
protected UIDashboard	createDashboard(UIComponentData componentData)
protected UIComponent	createDateTextBox(UIComponentData componentData)
protected UIComponent	createDecimalTextBox(UIComponentData componentData)
com.vaadin.ui.Field<?>	createEditor(Variant.RecordVariant editorDef, Type type) Instantiates an editor field based on the editor definition record and the value type.
protected UIComponent	createFileDownload(UIComponentData componentData)
protected UIComponent	createFileUpload(UIComponentData componentData)
protected UIFormLayout	createFormLayout(UIComponentData componentData)
protected UIGaugeChart	createGaugeChart(UIComponentData componentData)
protected UIGeolocator	createGeolocator(UIComponentData componentData)
protected UIComponent	createGridLayout(UIComponentData componentData)
protected UIComponent	createHorizontalLayout(UIComponentData componentData)
protected UIComponent	createImage(UIComponentData componentData)
protected UIComponent	createLazyComboBox(UIComponentData componentData)
protected UIListener	createListener(UIComponent component, RecordHolder uiListener) Creates listener based on the provided component definition.
UIListenerAction	createListenerAction(UIScreen screen, UIListener listener, RecordHolder definition, UIComponent scope) Creates listener action based on the provided definition.
protected UIMapDisplay	createMapDisplay(UIComponentData componentData)
protected UIComponent	createMessage(UIComponentData componentData)
protected UIComponent	createMultiSelectList(UIComponentData componentData)
protected UIComponent	createNavigationLink(UIComponentData componentData)
protected UIComponent	createOutputText(UIComponentData componentData)
protected UIComponent	createPanel(UIComponentData componentData)
protected UIPieChart	createPieChart(UIComponentData componentData)
protected UIPolarChart	createPolarChart(UIComponentData componentData)
protected UIComponent	createPopup(UIComponentData componentData)
protected UIComponent	createProcessDiagram(UIComponentData componentData)
protected UIComponent	createRadioButtonList(UIComponentData componentData)
protected UIComponent	createRepeater(UIComponentData componentData)
protected UIComponent	createSingleSelectList(UIComponentData componentData)
protected UIComponent	createTabbedLayout(UIComponentData componentData)
protected UIComponent	createTable(UIComponentData componentData)
protected UIComponent	createTextArea(UIComponentData componentData)
protected UIComponent	createTextBox(UIComponentData componentData)
protected UITokenField	createTokenField(UIComponentData componentData)
protected UITree2	createTree2(UIComponentData componentData)
protected UITreeTable2	createTreeTable2(UIComponentData componentData)
protected UIComponent	createVerticalLayout(UIComponentData componentData)
protected UIComponent	createViewModel(UIComponentData componentData)
String	getErrorMessage(Variant.RecordVariant validationError, UIComponent scope) Retrieves the error message from the "ui::ValidationError" record.
Injector	getInjector() Returns instance of Injector to use for injecting created components
static boolean	isUIValidationError(Variant.RecordVariant record) Checks if given record is the "old" Validation error with error message and a placement.
Map<UIComponent,List<String>>	mapErrorsToComponents(LspsScreen screen, LspsFormConnector.ValidationErrors validationErrors, Bindings bindings) Takes a set of validation errors and shows them on components in given screen.
void	refresh(UIComponent component) Refreshes the UI component.
protected void	setComponentReadOnly(UIComponent component, boolean readOnly) Sets the component to read-only state.
protected void	unapplyHint(UIComponent component, String hintName, Variant<Object> oldValue)
void	updateComponentCaption(UIComponent component) Sets caption property for the given component based on value of field UIFieldNames.LABEL.
protected void	updateComponentHelpText(UIComponent component) Sets description property for the given component based on value of field UIFieldNames.HELP_TEXT.
protected void	updateComponentRequired(UIComponent component) Adds required style class (UIComponentFactory.REQUIRED_STYLE_NAME) if the value of field UIFieldNames.REQUIRED is true.
void	updateHints(UIComponent component, Variant.MapVariant<String,Object> newHints, Variant.MapVariant<String,Object> oldHints) Applies all hints defined in the component definition associated with the given component.
protected void	updateImmediate(UIComponent component) Sets immediate property for the given component based on value of field UIFieldNames.TRIGGER_PROCESSING_ON_CHANGE
protected void	updateInputPrompt(UIComponent component) Sets input prompt property for the given component based on value of field UIFieldNames.PLACEHOLDER
protected void	updateReadOnly(UIComponent component) Sets read only and disabled property for the given component based on value of field UIFieldNames.READ_ONLY/UIFieldNames.DISABLED.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final boolean DEBUG

connector

protected final LspsAppConnector connector

Instance of LspsAppConnector

Constructor Detail

UIComponentFactoryImpl

public UIComponentFactoryImpl(LspsAppConnector connector)
                       throws NullPointerException

Creates new instance with the given application connector.

Parameters:

connector -

Throws:

NullPointerException - if connector or its injector is null

Method Detail

getInjector

public Injector getInjector()

Description copied from interface: UIComponentFactory

Returns instance of Injector to use for injecting created components

Specified by:

getInjector in interface UIComponentFactory

Returns:

injector

updateHints

public void updateHints(UIComponent component,
                        Variant.MapVariant<String,Object> newHints,
                        Variant.MapVariant<String,Object> oldHints)

Description copied from interface: UIComponentFactory

Applies all hints defined in the component definition associated with the given component. Invoked after UIComponent.refresh().

Specified by:

updateHints in interface UIComponentFactory

Parameters:

component - component to apply hints for

newHints - new presentation hints, never null, never absent.

oldHints - old presentation hints, never null, never absent.

unapplyHint

protected void unapplyHint(UIComponent component,
                           String hintName,
                           Variant<Object> oldValue)

applyHint

protected void applyHint(UIComponent component,
                         String hintName,
                         Variant<Object> newValue,
                         Variant<Object> oldValue)

Applies single hint of the given value to the given component

Parameters:

component - component to apply hint on

hintName - name of the hint to apply

newValue - value of the hint to apply

oldValue - previous value of the hint

applyListeners

public void applyListeners(UIComponent component)

Description copied from interface: UIComponentFactory

Applies all listeners defined in the component definition associated with the given component.

Specified by:

applyListeners in interface UIComponentFactory

Parameters:

component - the component, not null.

createListener

protected UIListener createListener(UIComponent component,
                                    RecordHolder uiListener)

Creates listener based on the provided component definition.

Parameters:

component - the owner component, not null.

uiListener - definition of the listener

Returns:

created listener

createListenerAction

public UIListenerAction createListenerAction(UIScreen screen,
                                             UIListener listener,
                                             RecordHolder definition,
                                             UIComponent scope)

Description copied from interface: UIComponentFactory

Creates listener action based on the provided definition.

Specified by:

createListenerAction in interface UIComponentFactory

Parameters:

screen - containing screen

listener - listener where this action is defined. Not null.

definition - definition of the listener action. Not null. Must be a subtype of ui::Action.

scope - run handle in this scope, not null.

Returns:

created listener action

createComponent

public UIComponent createComponent(LspsScreen screen,
                                   UIComponent parent,
                                   RecordHolder componentDefinition,
                                   UIComponentScope scope)

Description copied from interface: UIComponentFactory

Creates and injects component based on the provided component definition.

Specified by:

createComponent in interface UIComponentFactory

Parameters:

screen - containing screen, ignored if parent is not null.

parent - parent of the component in the UI component hierarchy, null if root.

componentDefinition - definition of the component to create, not null.

scope - component scope; if null, same scope as parent will be used

Returns:

created component

afterCreate

public void afterCreate(UIComponent component)

Description copied from interface: UIComponentFactory

Perform standard set of behaviors when component is created. The method will apply application listeners.

It is called automatically by UIComponentFactory.createComponent(LspsScreen, UIComponent, RecordHolder, UIComponentScope), after the component is created.

If the component implements Field, it's switched to buffered mode so that conversion/validation of the field value is properly integrated with the LSPS UI lifecycle.

Specified by:

afterCreate in interface UIComponentFactory

createComponent

protected UIComponent createComponent(UIComponentData componentData)

This method is responsible for creating a component based on the provided component data. The subclasses should override this method, in order to provide logic of creating custom components. The injection and initialization of the component does not need to be handled in this method.

Parameters:

componentData -

Returns:

created component

createFormLayout

protected UIFormLayout createFormLayout(UIComponentData componentData)

createGeolocator

protected UIGeolocator createGeolocator(UIComponentData componentData)

createMapDisplay

protected UIMapDisplay createMapDisplay(UIComponentData componentData)

createTreeTable2

protected UITreeTable2 createTreeTable2(UIComponentData componentData)

createTree2

protected UITree2 createTree2(UIComponentData componentData)

createCalendar

protected UICalendar createCalendar(UIComponentData componentData)

createBrowserFrame

protected UIBrowserFrame createBrowserFrame(UIComponentData componentData)

createPolarChart

protected UIPolarChart createPolarChart(UIComponentData componentData)

createCartesianChart

protected UICartesianChart createCartesianChart(UIComponentData componentData)

createGaugeChart

protected UIGaugeChart createGaugeChart(UIComponentData componentData)

createPieChart

protected UIPieChart createPieChart(UIComponentData componentData)

createDashboard

protected UIDashboard createDashboard(UIComponentData componentData)

createTokenField

protected UITokenField createTokenField(UIComponentData componentData)

createViewModel

protected UIComponent createViewModel(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.VIEW_MODEL_COMPONENT

createVerticalLayout

protected UIComponent createVerticalLayout(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.VERTICAL_LAYOUT_COMPONENT

createDateTextBox

protected UIComponent createDateTextBox(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.TEXT_BOX_COMPONENT which binding is of type date

createDecimalTextBox

protected UIComponent createDecimalTextBox(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.TEXT_BOX_COMPONENT which binding is not of type date

createTextBox

protected UIComponent createTextBox(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.TEXT_BOX_COMPONENT which binding is not of type date

createTextArea

protected UIComponent createTextArea(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.TEXT_AREA_COMPONENT

createTable

protected UIComponent createTable(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.TABLE_COMPONENT

createTabbedLayout

protected UIComponent createTabbedLayout(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.TABBED_LAYOUT_COMPONENT

createSingleSelectList

protected UIComponent createSingleSelectList(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.SINGLE_SELECT_LIST_COMPONENT

createRepeater

protected UIComponent createRepeater(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.REPEATER_COMPONENT

createRadioButtonList

protected UIComponent createRadioButtonList(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.RADIO_BUTTON_LIST_COMPONENT

createPopup

protected UIComponent createPopup(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.POPUP_COMPONENT

createPanel

protected UIComponent createPanel(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.PANEL_COMPONENT

createOutputText

protected UIComponent createOutputText(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.OUTPUT_TEXT_COMPONENT

createMultiSelectList

protected UIComponent createMultiSelectList(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.MULTI_SELECT_LIST_COMPONENT

createMessage

protected UIComponent createMessage(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.MESSAGE_COMPONENT

createNavigationLink

protected UIComponent createNavigationLink(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.NAVIGATION_LINK_COMPONENT

createImage

protected UIComponent createImage(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.IMAGE_COMPONENT

createHorizontalLayout

protected UIComponent createHorizontalLayout(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.HORIZONTAL_LAYOUT_COMPONENT

createGridLayout

protected UIComponent createGridLayout(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.GRID_LAYOUT_COMPONENT

createFileUpload

protected UIComponent createFileUpload(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.FILE_UPLOAD_COMPONENT

createFileDownload

protected UIComponent createFileDownload(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.FILE_DOWNLOAD_COMPONENT

createContainer

protected UIComponent createContainer(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.CONTAINER_COMPONENT

createConditional

protected UIComponent createConditional(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.CONDITIONAL_COMPONENT

createComboBox

protected UIComponent createComboBox(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.COMBO_BOX_COMPONENT

createLazyComboBox

protected UIComponent createLazyComboBox(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.LAZY_COMBO_BOX

createCheckBoxList

protected UIComponent createCheckBoxList(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.CHECK_BOX_LIST_COMPONENT

createCheckBox

protected UIComponent createCheckBox(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.CHECK_BOX_COMPONENT

createButtonLink

protected UIComponent createButtonLink(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.BUTTON_LINK_COMPONENT

createActionLink

protected UIComponent createActionLink(UIComponentData componentData)

Parameters:

componentData -

Returns:

created instance of ui component for component definition of type UIComponentNames.ACTION_LINK_COMPONENT

isUIValidationError

public static boolean isUIValidationError(Variant.RecordVariant record)

Checks if given record is the "old" Validation error with error message and a placement.

Parameters:

record - the record, not null.

Returns:

true if given record is either UIValidationError, or is the "old" ValidationError with message and placement.

createProcessDiagram

protected UIComponent createProcessDiagram(UIComponentData componentData)

mapErrorsToComponents

public Map<UIComponent,List<String>> mapErrorsToComponents(LspsScreen screen,
                                                           LspsFormConnector.ValidationErrors validationErrors,
                                                           Bindings bindings)

Description copied from interface: UIComponentFactory

Takes a set of validation errors and shows them on components in given screen.

The function does NOT set error messages to the components - it only returns a mapping of error messages. Call UIComponentFactory.addErrorMessagesToComponents(java.util.Map) to do that.

The specification of the algorithm is present in Workpackage 039: https://inside.whitestein.com/mediawiki/inside/LSPS:WP-039

Specified by:

mapErrorsToComponents in interface UIComponentFactory

Parameters:

screen - the containing screen, not null.

validationErrors - not null. A set of "ui::ValidationError" records produced by validations during last event process pass. Never null.

bindings - never null. The algorithm may use this map to find components displaying particular record property.

Returns:

mapping from component to a list of error messages to be applied to the component. Never null, may be empty.

addErrorMessagesToComponents

public void addErrorMessagesToComponents(Map<UIComponent,List<String>> errorMessages)

Description copied from interface: UIComponentFactory

Default implementation simply uses UIComponents.addComponentError(com.whitestein.lsps.vaadin.ui.components.UIComponent, String) to attach error messages to Vaadin components. Override to show error messages in different way, e.g. mark the components with a custom CSS style.

All error messages on all components must be cleared prior running this method - this method does not clear previous error messages. If you are adding custom CSS styles, you must manually clear the styles on all components. To get the list of all components, use AbstractScreen.getAllComponents().

Specified by:

addErrorMessagesToComponents in interface UIComponentFactory

Parameters:

errorMessages - maps vaadin components to a list of error messages which should be displayed. Never null, may be empty.

getErrorMessage

public String getErrorMessage(Variant.RecordVariant validationError,
                              UIComponent scope)

Description copied from interface: UIComponentFactory

Retrieves the error message from the "ui::ValidationError" record.

Specified by:

getErrorMessage in interface UIComponentFactory

Parameters:

validationError - an instance of "ui::ValidationError" record, not null.

scope - the error record was produced by listener executing in this scope. Not null.

Returns:

localized error message, should not be null.

refresh

public void refresh(UIComponent component)

Description copied from interface: UIComponentFactory

Refreshes the UI component. Default implementation simply calls UIComponent.refresh().

Specified by:

refresh in interface UIComponentFactory

Parameters:

component - the component, not null.

applyCommonProperties

public void applyCommonProperties(UIComponent component)

Description copied from interface: UIComponentFactory

Applies all standard properties from the component definition to the given input component. That includes:

• UIFieldNames.READ_ONLY - sets read only for the given component (Component.setEnabled(boolean))
• UIFieldNames.TRIGGER_PROCESSING_ON_CHANGE - sets immediate property (AbstractComponent.setImmediate(boolean))
• UIFieldNames.REQUIRED - adds required style class (UIComponentFactory.REQUIRED_STYLE_NAME) if the field value is true)
• UIFieldNames.LABEL - calls UIComponentFactory.updateComponentCaption(UIComponent)
• UIFieldNames.HELP_TEXT - sets help text property (AbstractComponent.setDescription(String))
• UIFieldNames.PLACEHOLDER - sets input prompt property (AbstractTextField.setInputPrompt(String))

Specified by:

applyCommonProperties in interface UIComponentFactory

updateComponentRequired

protected void updateComponentRequired(UIComponent component)

Adds required style class (UIComponentFactory.REQUIRED_STYLE_NAME) if the value of field UIFieldNames.REQUIRED is true.

Parameters:

component -

updateComponentCaption

public void updateComponentCaption(UIComponent component)

Sets caption property for the given component based on value of field UIFieldNames.LABEL.

Specified by:

updateComponentCaption in interface UIComponentFactory

Parameters:

component -

updateComponentHelpText

protected void updateComponentHelpText(UIComponent component)

Sets description property for the given component based on value of field UIFieldNames.HELP_TEXT.

Parameters:

component -

updateInputPrompt

protected void updateInputPrompt(UIComponent component)

Sets input prompt property for the given component based on value of field UIFieldNames.PLACEHOLDER

Parameters:

component - the component, not null.

updateImmediate

protected void updateImmediate(UIComponent component)

Sets immediate property for the given component based on value of field UIFieldNames.TRIGGER_PROCESSING_ON_CHANGE

Parameters:

component - the component, not null.

updateReadOnly

protected void updateReadOnly(UIComponent component)

Sets read only and disabled property for the given component based on value of field UIFieldNames.READ_ONLY/UIFieldNames.DISABLED. Disables the component if the screen is read only.

Parameters:

component - the component, not null.

setComponentReadOnly

protected void setComponentReadOnly(UIComponent component,
                                    boolean readOnly)

Sets the component to read-only state.

The default implementation calls Component.setEnabled(boolean).

Subclasses may override.

Parameters:

component -

readOnly -

createConverterForRenderer

public com.vaadin.data.util.converter.Converter<?,?> createConverterForRenderer(UIGrid owner,
                                                                                Variant.RecordVariant rendererDef)

Description copied from interface: UIComponentFactory

Optionally a converter may be used together with a renderer, to convert LSPS types to Java objects as expected by the renderer. May return null if no converter is necessary.

Specified by:

createConverterForRenderer in interface UIComponentFactory

Parameters:

owner - the grid that will use the renderer

rendererDef - the renderer definition, not null.

Returns:

the converter, may be null.

createEditor

public com.vaadin.ui.Field<?> createEditor(Variant.RecordVariant editorDef,
                                           Type type)

Description copied from interface: UIComponentFactory

Instantiates an editor field based on the editor definition record and the value type. The instantiated editor field allows to edit grid values.

The editors are used by the Grid component when editing grid values.

Specified by:

createEditor in interface UIComponentFactory

type - the type of the value

Returns:

the editor field, not null