Package org.dellroad.stuff.vaadin8

Class EnumComboBox<T extends Enum<T>>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractListing<T>

com.vaadin.ui.AbstractSingleSelect<T>

com.vaadin.ui.ComboBox<T>

org.dellroad.stuff.vaadin8.EnumComboBox<T>

Type Parameters:

T - enum type

All Implemented Interfaces:

HasFilterableDataProvider<T,String>, HasItems<T>, HasValue<T>, ContextClickEvent.ContextClickNotifier, FieldEvents.BlurNotifier, FieldEvents.FocusNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, SingleSelect<T>, Serializable

public class EnumComboBox<T extends Enum<T>>
extends ComboBox<T>

ComboBox that chooses an Enum value.

See Also:

Serialized Form

Nested Class Summary

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

ComboBox.CaptionFilter, ComboBox.DeclarativeStyleGenerator<T extends Object>, ComboBox.FetchItemsCallback<T extends Object>, ComboBox.NewItemHandler, ComboBox.NewItemProvider<T extends Object>

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

AbstractListing.AbstractListingExtension<T extends Object>

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

HasValue.ValueChangeEvent<V extends Object>, HasValue.ValueChangeListener<V extends Object>

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

Sizeable.Unit

Field Summary

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	Description
EnumComboBox()	Default constructor.
EnumComboBox(Class<T> enumClass)	Convenience constructor.
EnumComboBox(Class<T> enumClass, boolean allowEmpty)	Primary constructor.

Method Summary

Modifier and Type	Method	Description
Class<T>	getEnumClass()	Get the enum class.
void	setEnumClass(Class<T> enumClass)	Set the enum class.

Methods inherited from class com.vaadin.ui.ComboBox

addBlurListener, addFocusListener, addValueChangeListener, attach, detach, getDataProvider, getEmptySelectionCaption, getItemCaptionGenerator, getItemIconGenerator, getNewItemHandler, getNewItemProvider, getPageLength, getPlaceholder, getPopupWidth, getState, getState, getStyleGenerator, isEmptySelectionAllowed, isScrollToSelectedItem, isTextInputAllowed, readItem, readItems, setDataProvider, setDataProvider, setDataProvider, setDataProvider, setEmptySelectionAllowed, setEmptySelectionCaption, setItemCaptionGenerator, setItemIconGenerator, setItems, setItems, setItems, setItems, setItems, setNewItemHandler, setNewItemProvider, setPageLength, setPlaceholder, setPopupWidth, setScrollToSelectedItem, setStyleGenerator, setTextInputAllowed, updateSelectedItemState, writeItem

Methods inherited from class com.vaadin.ui.AbstractSingleSelect

addSelectionListener, getCustomAttributes, getSelectedItem, getValue, isReadOnly, isRequiredIndicatorVisible, isSelected, keyToItem, setReadOnly, setRequiredIndicatorVisible, setSelectedItem, setSelectedItem, setValue

Methods inherited from class com.vaadin.ui.AbstractListing

addDataGenerator, deserializeDeclarativeRepresentation, doReadDesign, doWriteDesign, focus, getDataCommunicator, getTabIndex, internalGetDataProvider, internalSetDataProvider, internalSetDataProvider, readDesign, readItem, removeDataGenerator, serializeDeclarativeRepresentation, setTabIndex, writeDesign, writeItems

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, 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, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, 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, 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.server.ClientConnector

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

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.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.data.HasFilterableDataProvider

setDataProvider

Methods inherited from interface com.vaadin.data.HasValue

clear, getDefaultValidator, getEmptyValue, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.server.Sizeable

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

Constructor Detail

EnumComboBox

public EnumComboBox()

Default constructor.

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

EnumComboBox

public EnumComboBox(Class<T> enumClass)

Convenience constructor.

Equivalent to:

EnumComboBox(enumClass, true);

Parameters:

enumClass - enum type, or null to leave unset

EnumComboBox

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

Primary constructor.

Parameters:

enumClass - enum type, or null to leave unset

allowEmpty - true to allow an empty selection, false otherwise

Method Detail

setEnumClass

public void setEnumClass(Class<T> enumClass)

Set the enum class.

Parameters:

enumClass - enum type

Throws:

IllegalArgumentException - if enumClass is null

getEnumClass

public Class<T> getEnumClass()

Get the enum class.

Returns:

enum type