info.magnolia.ui.vaadin.switcher

Class Switcher

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.v7.ui.AbstractLegacyComponent

com.vaadin.v7.ui.AbstractField<T>

com.vaadin.v7.ui.CustomField<Object>

info.magnolia.ui.vaadin.switcher.Switcher

All Implemented Interfaces:

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.HasComponents, com.vaadin.v7.data.Buffered, com.vaadin.v7.data.BufferedValidatable, com.vaadin.v7.data.Container.Viewer, com.vaadin.v7.data.Property<Object>, com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer, com.vaadin.v7.data.Validatable, com.vaadin.v7.ui.Field<Object>, Serializable, Iterable<com.vaadin.ui.Component>

public class Switcher
extends com.vaadin.v7.ui.CustomField<Object>
implements com.vaadin.v7.data.Container.Viewer

This class is a CustomField which wraps a ComboBox and additionally provides 2 arrows to "navigate" - actually to select the previous or the next item from the available set. Additionally, the Switcher can display a description of the currently selected item. Its Layout looks like
<< | combobox v | >>
description

See Also:

Serialized Form

Nested Class Summary

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

com.vaadin.v7.ui.AbstractField.FocusShortcut, com.vaadin.v7.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.v7.ui.Field

com.vaadin.v7.ui.Field.ValueChangeEvent

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

com.vaadin.v7.data.Buffered.SourceException

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	VARIATION_BLACK The constant for the color-variation "black".
static String	VARIATION_GREEN The constant for the color-variation "green" (which is default).

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
Switcher(Collection<?> options) Constructs a Switcher by a given collection.
Switcher(Collection<?> options, String colorVariation) Constructs a Switcher by a given Collection and a given color-variant.
Switcher(com.vaadin.v7.data.Container container) Constructs a Switcher by a given Container using the default color-variation (VARIATION_GREEN).
Switcher(com.vaadin.v7.data.Container container, String colorVariation) Constructs a Switcher by a given Container and colorVariant ("green" or "black", "green" is default).

Method Summary

Modifier and Type	Method and Description
void	addValueChangeListener(com.vaadin.v7.data.Property.ValueChangeListener valueChangeListener) This method adds a Property.ValueChangeListener to the underlying ComboBox. Such a ValueChangeListener would be notified not only when a user is changing the value directly with the wrapped ComboBox, but also fired when the arrows (back, forward) are used.
com.vaadin.v7.data.Container.Ordered	getContainerDataSource() Returns the Container.
protected Object	getInternalValue() Returns the selected item id.
com.vaadin.v7.data.Property	getPropertyDataSource() Gets the current data source of the field, if any (actually from its underlying ComboBox).
Class<?>	getType()
void	goBack() Sets the previous value - if the current value is not the first available in the set.
void	goForward() Sets the next value - if the current value is not the last available in the set.
protected com.vaadin.ui.Component	initContent()
void	setContainerDataSource(com.vaadin.v7.data.Container newDataSource) Sets the Container that serves as the data source of the viewer (on the underlying ComboBox).
void	setConverter(com.vaadin.v7.data.util.converter.Converter<Object,?> converter) Sets the Converter used to convert the field value to property data source type.
void	setDescriptionPropertyName(String descriptionPropertyName) Sets the name of the property which is used as the value of the description of an item. If it's not set, a description cannot be showed. When set, the passed Container should have set the property name descriptionPropertyName.
void	setItemCaptionPropertyId(String propertyId) Sets the item caption property of the underlying ComboBox.
void	setNullSelectionAllowed(boolean nullSelectionAllowed) Allow or disallow empty selection by the user; it applies #setNullSelectionAllowed on underlying ComboBox.
void	setNullSelectionItemId(Object item) Sets the item id that represents null value of this select; it applies #setNullSelectionItemId on underlying ComboBox.
void	setPropertyDataSource(com.vaadin.v7.data.Property newDataSource) Sets the specified Property as the data source for the field on the underlying ComboBox. For more details see the javadoc of AbstractField.setPropertyDataSource(com.vaadin.v7.data.Property).
void	setValue(Object newValue) Sets the visible value of the property.
void	withBorder(boolean withBorder) Adds the css style which ensures that the switcher comes with border on top and on bottom, if set true.

Methods inherited from class com.vaadin.v7.ui.CustomField

attach, focus, getContent, getTabIndex, iterator, setFocusDelegate, setHeight, setTabIndex, setWidth

Methods inherited from class com.vaadin.v7.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, beforeClientResponse, clear, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getModelType, getRequiredError, getState, getState, getValidators, getValue, isBuffered, isEmpty, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readDesign, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setLocale, setReadOnly, setRequired, setRequiredError, setValidationVisible, setValue, setValue, shouldHideErrors, validate, validate, valueChange, writeDesign

Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent

getExplicitImmediateValue, isImmediate, setImmediate

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, 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, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, 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

VARIATION_GREEN

public static final String VARIATION_GREEN

The constant for the color-variation "green" (which is default).

See Also:

Constant Field Values

VARIATION_BLACK

public static final String VARIATION_BLACK

The constant for the color-variation "black".

See Also:

Constant Field Values

Constructor Detail

Switcher

public Switcher(Collection<?> options)

Constructs a Switcher by a given collection. The collection is converted into a container during instantiation.

Parameters:

options -

Switcher

public Switcher(Collection<?> options,
                String colorVariation)

Constructs a Switcher by a given Collection and a given color-variant. The collection is converted into a container during instantiation.

Parameters:

options -

colorVariation -

Switcher

public Switcher(com.vaadin.v7.data.Container container)

Constructs a Switcher by a given Container using the default color-variation (VARIATION_GREEN).

Parameters:

container -

Switcher

public Switcher(com.vaadin.v7.data.Container container,
                String colorVariation)

Constructs a Switcher by a given Container and colorVariant ("green" or "black", "green" is default).

Parameters:

container -

colorVariation -

Method Detail

setDescriptionPropertyName

public void setDescriptionPropertyName(String descriptionPropertyName)

Sets the name of the property which is used as the value of the description of an item.
If it's not set, a description cannot be showed.
When set, the passed Container should have set the property name descriptionPropertyName.

Parameters:

descriptionPropertyName -

withBorder

public void withBorder(boolean withBorder)

Adds the css style which ensures that the switcher comes with border on top and on bottom, if set true. When set to false, the style gets removed.

Parameters:

withBorder -

initContent

protected com.vaadin.ui.Component initContent()

Specified by:

initContent in class com.vaadin.v7.ui.CustomField<Object>

setNullSelectionAllowed

public void setNullSelectionAllowed(boolean nullSelectionAllowed)

Allow or disallow empty selection by the user; it applies #setNullSelectionAllowed on underlying ComboBox.

Parameters:

nullSelectionAllowed -

setNullSelectionItemId

public void setNullSelectionItemId(Object item)

Sets the item id that represents null value of this select; it applies #setNullSelectionItemId on underlying ComboBox.

Parameters:

item -

setItemCaptionPropertyId

public void setItemCaptionPropertyId(String propertyId)

Sets the item caption property of the underlying ComboBox.

Parameters:

propertyId - the id of the property.

setValue

public void setValue(Object newValue)

Sets the visible value of the property.

The value of the select is the selected item id.

Sets the value to the underlying ComboBox.

Specified by:

setValue in interface com.vaadin.v7.data.Property<Object>

Overrides:

setValue in class com.vaadin.v7.ui.AbstractField<Object>

goForward

public void goForward()

Sets the next value - if the current value is not the last available in the set.

goBack

public void goBack()

Sets the previous value - if the current value is not the first available in the set.

addValueChangeListener

public void addValueChangeListener(com.vaadin.v7.data.Property.ValueChangeListener valueChangeListener)

This method adds a Property.ValueChangeListener to the underlying ComboBox.
Such a ValueChangeListener would be notified not only when a user is changing the value directly with the wrapped ComboBox, but also fired when the arrows (back, forward) are used.

Specified by:

addValueChangeListener in interface com.vaadin.v7.data.Property.ValueChangeNotifier

Overrides:

addValueChangeListener in class com.vaadin.v7.ui.AbstractField<Object>

getPropertyDataSource

public com.vaadin.v7.data.Property getPropertyDataSource()

Gets the current data source of the field, if any (actually from its underlying ComboBox).

Specified by:

getPropertyDataSource in interface com.vaadin.v7.data.Property.Viewer

Overrides:

getPropertyDataSource in class com.vaadin.v7.ui.AbstractField<Object>

Returns:

setPropertyDataSource

public void setPropertyDataSource(com.vaadin.v7.data.Property newDataSource)

Sets the specified Property as the data source for the field on the underlying ComboBox.
For more details see the javadoc of AbstractField.setPropertyDataSource(com.vaadin.v7.data.Property).

Specified by:

setPropertyDataSource in interface com.vaadin.v7.data.Property.Viewer

Overrides:

setPropertyDataSource in class com.vaadin.v7.ui.AbstractField<Object>

Parameters:

newDataSource -

setConverter

public void setConverter(com.vaadin.v7.data.util.converter.Converter<Object,?> converter)

Sets the Converter used to convert the field value to property data source type. The converter must have a presentation type that matches the field type.

Overrides:

setConverter in class com.vaadin.v7.ui.AbstractField<Object>

Parameters:

converter -

getInternalValue

protected Object getInternalValue()

Returns the selected item id.

Overrides:

getInternalValue in class com.vaadin.v7.ui.AbstractField<Object>

Returns:

Object

getType

public Class<?> getType()

Specified by:

getType in interface com.vaadin.v7.data.Property<Object>

Specified by:

getType in class com.vaadin.v7.ui.AbstractField<Object>

setContainerDataSource

public void setContainerDataSource(com.vaadin.v7.data.Container newDataSource)

Sets the Container that serves as the data source of the viewer (on the underlying ComboBox).

Specified by:

setContainerDataSource in interface com.vaadin.v7.data.Container.Viewer

Parameters:

newDataSource -

getContainerDataSource

public com.vaadin.v7.data.Container.Ordered getContainerDataSource()

Returns the Container.

Specified by:

getContainerDataSource in interface com.vaadin.v7.data.Container.Viewer

Returns: