Package org.dellroad.stuff.vaadin7

Class EnumComboBox

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<Object>

com.vaadin.ui.AbstractSelect

com.vaadin.ui.ComboBox

org.dellroad.stuff.vaadin7.EnumComboBox

All Implemented Interfaces:

Buffered, BufferedValidatable, Container, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.Viewer, Property<Object>, Property.Editor, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, Action.ShortcutNotifier, ConnectorEventListener, ContextClickEvent.ContextClickNotifier, FieldEvents.BlurNotifier, FieldEvents.FocusNotifier, MethodEventSource, ClientConnector, Sizeable, VariableOwner, Connector, AbstractSelect.Filtering, Component, Component.Focusable, Field<Object>, LegacyComponent, Serializable, EventListener

public class EnumComboBox
extends ComboBox

ComboBox that chooses an Enum value.

See Also:

EnumContainer, Serialized Form

Nested Class Summary

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

ComboBox.ItemStyleGenerator

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

AbstractSelect.AbstractSelectTargetDetails, AbstractSelect.AcceptItem, AbstractSelect.CaptionChangeListener, AbstractSelect.DefaultNewItemHandler, AbstractSelect.Filtering, AbstractSelect.ItemCaptionMode, AbstractSelect.ItemDescriptionGenerator, AbstractSelect.NewItemHandler, AbstractSelect.TargetItemIs, AbstractSelect.VerticalLocationIs

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

AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent

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

Buffered.SourceException

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

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

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

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

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

Container.Editor, Container.Filter, Container.Filterable, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.SimpleFilterable, Container.Sortable, Container.Viewer

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

Field.ValueChangeEvent

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

Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T extends Object>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

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

Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.ComboBox

pageLength

Fields inherited from class com.vaadin.ui.AbstractSelect

ITEM_CAPTION_MODE_EXPLICIT, ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID, ITEM_CAPTION_MODE_ICON_ONLY, ITEM_CAPTION_MODE_ID, ITEM_CAPTION_MODE_INDEX, ITEM_CAPTION_MODE_ITEM, ITEM_CAPTION_MODE_PROPERTY, itemIdMapper, items

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.ui.AbstractSelect.Filtering

FILTERINGMODE_CONTAINS, FILTERINGMODE_OFF, FILTERINGMODE_STARTSWITH

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	Description
EnumComboBox()	Default constructor.
EnumComboBox(Class<T> enumClass)	Convenience constructor.
EnumComboBox(Class<T> enumClass, boolean allowNull)	Convenience constructor.
EnumComboBox(Class<T> enumClass, String displayPropertyName)	Convenience constructor.
EnumComboBox(Class<T> enumClass, String displayPropertyName, boolean allowNull)	Convenience constructor.
EnumComboBox(EnumContainer<?> container, String displayPropertyName, boolean allowNull)	Primary constructor.

Method Summary

Modifier and Type	Method	Description
<T extends Enum<T>> void	setEnumDataSource(Class<T> enumClass)	Set the Enum type whose instances serve as this instance's data source.

Methods inherited from class com.vaadin.ui.ComboBox

addBlurListener, addFocusListener, addListener, addListener, buildFilter, changeVariables, containerItemSetChange, getFilteredOptions, getFilteringMode, getInputPrompt, getItemStyleGenerator, getOptionsWithFilter, getPageLength, getPopupWidth, getState, isMultiSelect, isScrollToSelectedItem, isTextInputAllowed, paintContent, removeBlurListener, removeFocusListener, removeListener, removeListener, setFilteringMode, setInputPrompt, setItemStyleGenerator, setMultiSelect, setPageLength, setPopupWidth, setScrollToSelectedItem, setTextInputAllowed

Methods inherited from class com.vaadin.ui.AbstractSelect

addContainerProperty, addItem, addItem, addItems, addItems, addItemSetChangeListener, addListener, addListener, addPropertySetChangeListener, attach, containerPropertySetChange, containsId, detach, fireItemSetChange, firePropertySetChange, getCaptionChangeListener, getContainerDataSource, getContainerProperty, getContainerPropertyIds, getItem, getItemCaption, getItemCaptionMode, getItemCaptionPropertyId, getItemIcon, getItemIconPropertyId, getItemIds, getListeners, getNewItemHandler, getNullSelectionItemId, getType, getType, getValue, getVisibleItemIds, isEmpty, isNewItemsAllowed, isNullSelectionAllowed, isSelected, paintItem, readDesign, readItem, readItems, removeAllItems, removeContainerProperty, removeItem, removeItemSetChangeListener, removeListener, removeListener, removePropertySetChangeListener, sanitizeSelection, select, setContainerDataSource, setItemCaption, setItemCaptionMode, setItemCaptionPropertyId, setItemIcon, setItemIconPropertyId, setNewItemHandler, setNewItemsAllowed, setNullSelectionAllowed, setNullSelectionItemId, setValue, setValue, size, unselect, writeDesign, writeItem, writeItems

Methods inherited from class com.vaadin.ui.AbstractField

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

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, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, 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, 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.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.Sizeable

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

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

Constructor Detail

EnumComboBox

public EnumComboBox()

Default constructor.

Caller must separately invoke setEnumDataSource(java.lang.Class<T>).

EnumComboBox

public EnumComboBox(Class<T> enumClass)

Convenience constructor.

Equivalent to:

EnumComboBox(enumClass, EnumContainer.TO_STRING_PROPERTY.getName(), true);

Type Parameters:

T - enum type

Parameters:

enumClass - enum type, or null to leave data source unset

EnumComboBox

public EnumComboBox(Class<T> enumClass,
                    boolean allowNull)

Convenience constructor.

Equivalent to:

EnumComboBox(enumClass, EnumContainer.TO_STRING_PROPERTY, allowNull);

Type Parameters:

T - enum type

Parameters:

enumClass - enum type, or null to leave data source unset

allowNull - true to allow a null selection, false otherwise

EnumComboBox

public EnumComboBox(Class<T> enumClass,
                    String displayPropertyName)

Convenience constructor.

Equivalent to:

EnumComboBox(enumClass, displayPropertyName, false);

Type Parameters:

T - enum type

Parameters:

enumClass - enum type

displayPropertyName - container property to display in the combo box

EnumComboBox

public EnumComboBox(Class<T> enumClass,
                    String displayPropertyName,
                    boolean allowNull)

Convenience constructor.

Equivalent to:

EnumComboBox(enumClass != null ? new EnumContainer<T>(enumClass) : null, displayPropertyName, allowNull);

Type Parameters:

T - enum type

Parameters:

enumClass - enum type, or null to leave data source unset

displayPropertyName - container property to display in the combo box

allowNull - true to allow a null selection, false otherwise

EnumComboBox

public EnumComboBox(EnumContainer<?> container,
                    String displayPropertyName,
                    boolean allowNull)

Primary constructor.

This instance is configured for item caption AbstractSelect.ItemCaptionMode.PROPERTY mode, with displayPropertyName as the item caption property.

Parameters:

container - container data source, or null to leave data source unset

displayPropertyName - container property to display in the combo box

allowNull - true to allow a null selection, false otherwise

Method Detail

setEnumDataSource

public <T extends Enum<T>> void setEnumDataSource(Class<T> enumClass)

Set the Enum type whose instances serve as this instance's data source.

Type Parameters:

T - enum type

Parameters:

enumClass - enum class instance

Throws:

IllegalArgumentException - if enumClass is null