com.whitestein.lsps.vaadin.forms

Class FormComponentFactory

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponentFactory

All Implemented Interfaces:

Serializable

public class FormComponentFactory
extends Object
implements Serializable

Creates FormComponent and grid renderers. Override create(Variant.RecordVariant) if you wish to add support for additional components. Override createRenderer(WGrid, Variant.RecordVariant) and createConverterForRenderer(WGrid, Variant.RecordVariant) if you wish to add support for additional Grid renderers.

Author:

mvy

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormComponentFactory()

Method Summary

Modifier and Type	Method and Description
FormComponent	create(Variant.RecordVariant def) Creates an instance of given component.
protected FormComponent	createAccordion(Variant.RecordVariant def)
protected FormComponent	createActionLink(Variant.RecordVariant def)
protected FormComponent	createBrowserFrame(Variant.RecordVariant def)
protected FormComponent	createButton(Variant.RecordVariant def)
protected com.vaadin.ui.renderers.Renderer<?>	createButtonRenderer(WGrid owner, Variant.RecordVariant rendererDef)
protected FormComponent	createCalendar(Variant.RecordVariant def)
protected FormComponent	createCartesianChart(Variant.RecordVariant def)
protected FormComponent	createCheckBox(Variant.RecordVariant def)
protected FormComponent	createCheckBoxList(Variant.RecordVariant def)
protected FormComponent	createCollapsible(Variant.RecordVariant def)
protected FormComponent	createComboBox(Variant.RecordVariant def)
com.vaadin.data.util.converter.Converter<?,?>	createConverterForRenderer(WGrid 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 FormComponent	createCssLayout(Variant.RecordVariant def)
protected WCustomField	createCustomField(Variant.RecordVariant def)
protected FormComponent	createDateField(Variant.RecordVariant def)
protected com.vaadin.ui.renderers.Renderer<?>	createDateRenderer(Variant.RecordVariant rendererDef)
protected FormComponent	createDecimalField(Variant.RecordVariant def)
protected FormComponent	createDownload(Variant.RecordVariant def)
protected FormComponent	createDropZone(Variant.RecordVariant def)
com.vaadin.ui.Field<?>	createEditor(Variant.RecordVariant editorDef, Type type) Creates a new editor field from the editor definition and the model type.
protected com.vaadin.ui.renderers.Renderer<?>	createEnumerationRenderer(Variant.RecordVariant rendererDef)
ErrorMessageController	createErrorMessageController(Form form) Creates an error message controller for the form.
protected FormComponent	createFormLayout(Variant.RecordVariant def)
protected FormComponent	createGaugeChart(Variant.RecordVariant def)
protected FormComponent	createGrid(Variant.RecordVariant def)
protected FormComponent	createGridLayout(Variant.RecordVariant def)
protected FormComponent	createGridStackDashboard(Variant.RecordVariant def)
protected FormComponent	createHorizontalLayout(Variant.RecordVariant def)
protected FormComponent	createHorizontalSplitPanel(Variant.RecordVariant def)
protected com.vaadin.ui.renderers.Renderer<?>	createHtmlRenderer(WGrid owner, Variant.RecordVariant rendererDef)
protected FormComponent	createImage(Variant.RecordVariant def)
protected com.vaadin.ui.renderers.Renderer<?>	createImageRenderer(WGrid owner, Variant.RecordVariant rendererDef)
protected FormComponent	createLabel(Variant.RecordVariant def)
protected FormComponent	createLink(Variant.RecordVariant def)
protected com.vaadin.ui.renderers.Renderer<?>	createLinkRenderer(WGrid owner, Variant.RecordVariant rendererDef)
protected FormComponent	createMapDisplay(Variant.RecordVariant def)
protected FormComponent	createMultiselectComboBox(Variant.RecordVariant def)
protected FormComponent	createMultiSelectList(Variant.RecordVariant def)
protected com.vaadin.ui.renderers.Renderer<?>	createNumberRenderer(Variant.RecordVariant rendererDef)
protected FormComponent	createPanel(Variant.RecordVariant def)
protected FormComponent	createPasswordField(Variant.RecordVariant def)
protected FormComponent	createPdfViewer(Variant.RecordVariant def)
protected FormComponent	createPieChart(Variant.RecordVariant def)
protected FormComponent	createPolarChart(Variant.RecordVariant def)
protected FormComponent	createPopup(Variant.RecordVariant def)
protected FormComponent	createRadioButtonList(Variant.RecordVariant def)
com.vaadin.ui.renderers.Renderer<?>	createRenderer(WGrid owner, Variant.RecordVariant rendererDef) Creates a renderer instance which renders Grid cells.
protected FormComponent	createRichTextArea(Variant.RecordVariant def)
protected FormComponent	createSearchComboBox(Variant.RecordVariant def)
protected FormComponent	createSingleSelectList(Variant.RecordVariant def)
protected FormComponent	createSlider(Variant.RecordVariant def)
protected FormComponent	createSortableLayout(Variant.RecordVariant def)
protected FormComponent	createTable(Variant.RecordVariant def)
protected FormComponent	createTabSheet(Variant.RecordVariant def)
protected FormComponent	createTextArea(Variant.RecordVariant def)
protected FormComponent	createTextField(Variant.RecordVariant def)
protected FormComponent	createTokenField(Variant.RecordVariant def)
protected FormComponent	createTree(Variant.RecordVariant def)
protected FormComponent	createTreeTable(Variant.RecordVariant def)
protected FormComponent	createUpload(Variant.RecordVariant def)
protected FormComponent	createVerticalLayout(Variant.RecordVariant def)
protected FormComponent	createVerticalSplitPanel(Variant.RecordVariant def)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormComponentFactory

public FormComponentFactory()

Method Detail

create

public FormComponent create(Variant.RecordVariant def)

Creates an instance of given component.

Parameters:

def - the component definition, subclass of forms::FormComponent

Returns:

the component instance, not null.

Throws:

IllegalStateException - if the component type is not recognized and cannot be constructed.

RuntimeException - if the component construction fails.

createDropZone

protected FormComponent createDropZone(Variant.RecordVariant def)

createPdfViewer

protected FormComponent createPdfViewer(Variant.RecordVariant def)

createTokenField

protected FormComponent createTokenField(Variant.RecordVariant def)

createPasswordField

protected FormComponent createPasswordField(Variant.RecordVariant def)

createTreeTable

protected FormComponent createTreeTable(Variant.RecordVariant def)

createMapDisplay

protected FormComponent createMapDisplay(Variant.RecordVariant def)

createTree

protected FormComponent createTree(Variant.RecordVariant def)

createDownload

protected FormComponent createDownload(Variant.RecordVariant def)

createUpload

protected FormComponent createUpload(Variant.RecordVariant def)

createImage

protected FormComponent createImage(Variant.RecordVariant def)

createCollapsible

protected FormComponent createCollapsible(Variant.RecordVariant def)

createLink

protected FormComponent createLink(Variant.RecordVariant def)

createPanel

protected FormComponent createPanel(Variant.RecordVariant def)

createHorizontalSplitPanel

protected FormComponent createHorizontalSplitPanel(Variant.RecordVariant def)

createVerticalSplitPanel

protected FormComponent createVerticalSplitPanel(Variant.RecordVariant def)

createCustomField

protected WCustomField createCustomField(Variant.RecordVariant def)

createCheckBoxList

protected FormComponent createCheckBoxList(Variant.RecordVariant def)

createRadioButtonList

protected FormComponent createRadioButtonList(Variant.RecordVariant def)

createTable

protected FormComponent createTable(Variant.RecordVariant def)

createGridLayout

protected FormComponent createGridLayout(Variant.RecordVariant def)

createActionLink

protected FormComponent createActionLink(Variant.RecordVariant def)

createMultiSelectList

protected FormComponent createMultiSelectList(Variant.RecordVariant def)

createTabSheet

protected FormComponent createTabSheet(Variant.RecordVariant def)

createAccordion

protected FormComponent createAccordion(Variant.RecordVariant def)

createPopup

protected FormComponent createPopup(Variant.RecordVariant def)

createGridStackDashboard

protected FormComponent createGridStackDashboard(Variant.RecordVariant def)

createSingleSelectList

protected FormComponent createSingleSelectList(Variant.RecordVariant def)

createComboBox

protected FormComponent createComboBox(Variant.RecordVariant def)

createSearchComboBox

protected FormComponent createSearchComboBox(Variant.RecordVariant def)

createMultiselectComboBox

protected FormComponent createMultiselectComboBox(Variant.RecordVariant def)

createGrid

protected FormComponent createGrid(Variant.RecordVariant def)

createBrowserFrame

protected FormComponent createBrowserFrame(Variant.RecordVariant def)

createDateField

protected FormComponent createDateField(Variant.RecordVariant def)

createSlider

protected FormComponent createSlider(Variant.RecordVariant def)

createDecimalField

protected FormComponent createDecimalField(Variant.RecordVariant def)

createTextField

protected FormComponent createTextField(Variant.RecordVariant def)

createTextArea

protected FormComponent createTextArea(Variant.RecordVariant def)

createRichTextArea

protected FormComponent createRichTextArea(Variant.RecordVariant def)

createCheckBox

protected FormComponent createCheckBox(Variant.RecordVariant def)

createFormLayout

protected FormComponent createFormLayout(Variant.RecordVariant def)

createButton

protected FormComponent createButton(Variant.RecordVariant def)

createHorizontalLayout

protected FormComponent createHorizontalLayout(Variant.RecordVariant def)

createVerticalLayout

protected FormComponent createVerticalLayout(Variant.RecordVariant def)

createCssLayout

protected FormComponent createCssLayout(Variant.RecordVariant def)

createSortableLayout

protected FormComponent createSortableLayout(Variant.RecordVariant def)

createLabel

protected FormComponent createLabel(Variant.RecordVariant def)

createPieChart

protected FormComponent createPieChart(Variant.RecordVariant def)

createCartesianChart

protected FormComponent createCartesianChart(Variant.RecordVariant def)

createPolarChart

protected FormComponent createPolarChart(Variant.RecordVariant def)

createGaugeChart

protected FormComponent createGaugeChart(Variant.RecordVariant def)

createCalendar

protected FormComponent createCalendar(Variant.RecordVariant def)

createRenderer

public com.vaadin.ui.renderers.Renderer<?> createRenderer(WGrid owner,
                                                          Variant.RecordVariant rendererDef)

Creates a renderer instance which renders Grid cells.

Parameters:

owner - the owner component, usually WGrid, not null.

rendererDef - the renderer definition record, subclass of forms::Renderer, not null.

Returns:

the Grid renderer, not null.

Throws:

IllegalStateException - if the renderer type is not recognized and cannot be constructed.

RuntimeException - if the renderer construction fails.

createImageRenderer

protected com.vaadin.ui.renderers.Renderer<?> createImageRenderer(WGrid owner,
                                                                  Variant.RecordVariant rendererDef)

createHtmlRenderer

protected com.vaadin.ui.renderers.Renderer<?> createHtmlRenderer(WGrid owner,
                                                                 Variant.RecordVariant rendererDef)

createButtonRenderer

protected com.vaadin.ui.renderers.Renderer<?> createButtonRenderer(WGrid owner,
                                                                   Variant.RecordVariant rendererDef)

createLinkRenderer

protected com.vaadin.ui.renderers.Renderer<?> createLinkRenderer(WGrid owner,
                                                                 Variant.RecordVariant rendererDef)

createDateRenderer

protected com.vaadin.ui.renderers.Renderer<?> createDateRenderer(Variant.RecordVariant rendererDef)

createNumberRenderer

protected com.vaadin.ui.renderers.Renderer<?> createNumberRenderer(Variant.RecordVariant rendererDef)

createEnumerationRenderer

protected com.vaadin.ui.renderers.Renderer<?> createEnumerationRenderer(Variant.RecordVariant rendererDef)

createConverterForRenderer

public com.vaadin.data.util.converter.Converter<?,?> createConverterForRenderer(WGrid 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. May return null if no converter is necessary.

Parameters:

owner - the owner of the renderer

rendererDef - the renderer definition, subclass of forms::Renderer, not null.

Returns:

the converter, may be null.

createEditor

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

Creates a new editor field from the editor definition and the model type.

Parameters:

editorDef - the editor definition

type - the model type

Returns:

editor field capable of editing the given model type

createErrorMessageController

public ErrorMessageController createErrorMessageController(Form form)

Creates an error message controller for the form.

Parameters:

form - the form whose error messages should be managed by the created controller

Returns:

the controller of error messages for the form