info.magnolia.ui.form.field

Class AbstractCustomMultiField<D extends FieldDefinition,T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<T>

com.vaadin.ui.CustomField<T>

info.magnolia.ui.form.field.AbstractCustomMultiField<D,T>

Type Parameters:

T - Property Type linked to this Field.

D - FieldDefinition Implementation used by the implemented Field.

All Implemented Interfaces:

com.vaadin.data.Buffered, com.vaadin.data.BufferedValidatable, com.vaadin.data.Property<T>, com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer, com.vaadin.data.Validatable, com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Field<T>, com.vaadin.ui.HasComponents, Serializable, Iterable<com.vaadin.ui.Component>

Direct Known Subclasses:

CompositeField, MultiField, SwitchableField

public abstract class AbstractCustomMultiField<D extends FieldDefinition,T>
extends com.vaadin.ui.CustomField<T>

Abstract implementation of CustomField used for multi fields components.
It expose generic methods allowing to:
- Build a Field based on a ConfiguredFieldDefinition.
- Retrieve the list of Fields contained into the main component
- Override Validate and get Error Message in order to include these call to the embedded Fields.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField

com.vaadin.ui.AbstractField.FocusShortcut, com.vaadin.ui.AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Field

com.vaadin.ui.Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Buffered

com.vaadin.data.Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.data.Property

com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyException, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.Transactional<T>, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer

Field Summary

Fields

Modifier and Type	Field and Description
protected info.magnolia.objectfactory.ComponentProvider	componentProvider
protected D	definition
protected FieldFactoryFactory	fieldFactoryFactory
protected info.magnolia.cms.i18n.I18nContentSupport	i18nContentSupport Deprecated. since 5.3.5 (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
protected com.vaadin.data.Item	relatedFieldItem
protected com.vaadin.ui.AbstractOrderedLayout	root
protected com.vaadin.data.Property.ValueChangeListener	selectionListener Listener used to update the Data source property.

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCustomMultiField(D definition, FieldFactoryFactory fieldFactoryFactory, info.magnolia.objectfactory.ComponentProvider componentProvider, com.vaadin.data.Item relatedFieldItem, I18NAuthoringSupport i18nAuthoringSupport)
protected	AbstractCustomMultiField(D definition, FieldFactoryFactory fieldFactoryFactory, info.magnolia.cms.i18n.I18nContentSupport i18nContentSupport, info.magnolia.objectfactory.ComponentProvider componentProvider, com.vaadin.data.Item relatedFieldItem) Deprecated. since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.Field<?>	createLocalField(FieldDefinition fieldDefinition, com.vaadin.data.Property<?> property, boolean setCaptionToNull) Create a new Field based on a FieldDefinition.
protected int	findPropertyId(com.vaadin.data.Item item, com.vaadin.data.Property<?> property) Helper method to find propertyId for a given property within item datasource.
com.vaadin.server.ErrorMessage	getErrorMessage() Get the error message, if any.
protected List<com.vaadin.ui.AbstractField<T>>	getFields(com.vaadin.ui.HasComponents root, boolean onlyValid) Utility method that return a list of Fields embedded into a root custom field.
protected void	initFields()
protected abstract void	initFields(T fieldValues) Initialize the fields based on the newValues. Implemented logic should: - remove all component from the root component.
boolean	isEmpty() For a custom multi field empty means it contains no sub-fields OR at least one of its sub-fields isEmpty() method returns true.
boolean	isValid() Validate all fields from the root container.
void	setLocale(Locale locale) Handle I18NAuthoringSupport.i18nize(HasComponents, Locale) events in order to refresh the field and display the new property.

Methods inherited from class com.vaadin.ui.CustomField

attach, getContent, initContent, iterator, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, beforeClientResponse, clear, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getState, getState, getTabIndex, getType, getValidators, getValue, isBuffered, isImmediate, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValidationVisible, readDesign, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setValue, setValue, shouldHideErrors, toString, validate, validate, valueChange, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, readDesign, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Field Detail

fieldFactoryFactory

protected final FieldFactoryFactory fieldFactoryFactory

i18nContentSupport

@Deprecated
protected final info.magnolia.cms.i18n.I18nContentSupport i18nContentSupport

Deprecated. since 5.3.5 (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.

componentProvider

protected final info.magnolia.objectfactory.ComponentProvider componentProvider

definition

protected final D extends FieldDefinition definition

relatedFieldItem

protected final com.vaadin.data.Item relatedFieldItem

root

protected com.vaadin.ui.AbstractOrderedLayout root

selectionListener

protected com.vaadin.data.Property.ValueChangeListener selectionListener

Listener used to update the Data source property.

Constructor Detail

AbstractCustomMultiField

protected AbstractCustomMultiField(D definition,
                                   FieldFactoryFactory fieldFactoryFactory,
                                   info.magnolia.objectfactory.ComponentProvider componentProvider,
                                   com.vaadin.data.Item relatedFieldItem,
                                   I18NAuthoringSupport i18nAuthoringSupport)

AbstractCustomMultiField

@Deprecated
protected AbstractCustomMultiField(D definition,
                                               FieldFactoryFactory fieldFactoryFactory,
                                               info.magnolia.cms.i18n.I18nContentSupport i18nContentSupport,
                                               info.magnolia.objectfactory.ComponentProvider componentProvider,
                                               com.vaadin.data.Item relatedFieldItem)

Deprecated. since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.

Method Detail

initFields

protected abstract void initFields(T fieldValues)

Initialize the fields based on the newValues.
Implemented logic should:
- remove all component from the root component.
- for every fieldValues value, add the appropriate field.
- add all others needed component (like add button...)

setLocale

public void setLocale(Locale locale)

Handle I18NAuthoringSupport.i18nize(HasComponents, Locale) events in order to refresh the field
and display the new property.

Overrides:

setLocale in class com.vaadin.ui.AbstractField<T>

initFields

protected void initFields()

findPropertyId

protected int findPropertyId(com.vaadin.data.Item item,
                             com.vaadin.data.Property<?> property)

Helper method to find propertyId for a given property within item datasource.

createLocalField

protected com.vaadin.ui.Field<?> createLocalField(FieldDefinition fieldDefinition,
                                                  com.vaadin.data.Property<?> property,
                                                  boolean setCaptionToNull)

Create a new Field based on a FieldDefinition.

getFields

protected List<com.vaadin.ui.AbstractField<T>> getFields(com.vaadin.ui.HasComponents root,
                                                         boolean onlyValid)

Utility method that return a list of Fields embedded into a root custom field.

Parameters:

root -

onlyValid - if set to true, return only the isValid() fields.

isValid

public boolean isValid()

Validate all fields from the root container. Fields which are not visible are skipped. Stops at the first error encountered.

Specified by:

isValid in interface com.vaadin.data.Validatable

Overrides:

isValid in class com.vaadin.ui.AbstractField<T>

getErrorMessage

public com.vaadin.server.ErrorMessage getErrorMessage()

Get the error message, if any. Aggregates all errors for all fields in this custom multi field.

Overrides:

getErrorMessage in class com.vaadin.ui.AbstractField<T>

isEmpty

public boolean isEmpty()

For a custom multi field empty means it contains no sub-fields OR at least one of its sub-fields isEmpty() method returns true.

Specified by:

isEmpty in interface com.vaadin.ui.Field<T>

Overrides:

isEmpty in class com.vaadin.ui.AbstractField<T>