info.magnolia.ui.form.field

Class SwitchableField

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<SwitchableFieldDefinition,com.vaadin.data.util.PropertysetItem>

info.magnolia.ui.form.field.SwitchableField

All Implemented Interfaces:

com.vaadin.data.Buffered, com.vaadin.data.BufferedValidatable, com.vaadin.data.Property<com.vaadin.data.util.PropertysetItem>, 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<com.vaadin.data.util.PropertysetItem>, com.vaadin.ui.HasComponents, Serializable, Iterable<com.vaadin.ui.Component>

public class SwitchableField
extends AbstractCustomMultiField<SwitchableFieldDefinition,com.vaadin.data.util.PropertysetItem>

Switchable field.
Display a field composed of two main sections
- a Select Section (list or checkBox)
- a Field Section displaying the field currently selected.

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 inherited from class info.magnolia.ui.form.field.AbstractCustomMultiField

componentProvider, definition, fieldFactoryFactory, i18nContentSupport, relatedFieldItem, root, selectionListener

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

Constructor and Description
SwitchableField(SwitchableFieldDefinition definition, FieldFactoryFactory fieldFactoryFactory, info.magnolia.objectfactory.ComponentProvider componentProvider, com.vaadin.data.Item relatedFieldItem, I18NAuthoringSupport i18nAuthoringSupport)
SwitchableField(SwitchableFieldDefinition 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<?>	getFieldByName(String fieldName) Returns a Field if it's existing.
Class<? extends com.vaadin.data.util.PropertysetItem>	getType()
protected com.vaadin.ui.Component	initContent()
protected void	initFields(com.vaadin.data.util.PropertysetItem fieldValues) Initialize the fields based on the newValues.
boolean	isEmpty() A switchable field is empty when no choice has been made yet.

Methods inherited from class info.magnolia.ui.form.field.AbstractCustomMultiField

createLocalField, findPropertyId, getErrorMessage, getFields, initFields, isValid, setLocale

Methods inherited from class com.vaadin.ui.CustomField

attach, getContent, 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, 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

Constructor Detail

SwitchableField

public SwitchableField(SwitchableFieldDefinition definition,
                       FieldFactoryFactory fieldFactoryFactory,
                       info.magnolia.objectfactory.ComponentProvider componentProvider,
                       com.vaadin.data.Item relatedFieldItem,
                       I18NAuthoringSupport i18nAuthoringSupport)

SwitchableField

@Deprecated
public SwitchableField(SwitchableFieldDefinition 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

initContent

protected com.vaadin.ui.Component initContent()

Specified by:

initContent in class com.vaadin.ui.CustomField<com.vaadin.data.util.PropertysetItem>

initFields

protected void initFields(com.vaadin.data.util.PropertysetItem fieldValues)

Description copied from class: AbstractCustomMultiField

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

Specified by:

initFields in class AbstractCustomMultiField<SwitchableFieldDefinition,com.vaadin.data.util.PropertysetItem>

getFieldByName

protected com.vaadin.ui.Field<?> getFieldByName(String fieldName)

Returns a Field if it's existing. Otherwise returns a null.

getType

public Class<? extends com.vaadin.data.util.PropertysetItem> getType()

Specified by:

getType in interface com.vaadin.data.Property<com.vaadin.data.util.PropertysetItem>

Specified by:

getType in class com.vaadin.ui.AbstractField<com.vaadin.data.util.PropertysetItem>

isEmpty

public boolean isEmpty()

A switchable field is empty when no choice has been made yet. This method is called by Vaadin framework to perform a basic isRequired check.

Specified by:

isEmpty in interface com.vaadin.ui.Field<com.vaadin.data.util.PropertysetItem>

Overrides:

isEmpty in class AbstractCustomMultiField<SwitchableFieldDefinition,com.vaadin.data.util.PropertysetItem>