T - item typepublic class ListSelect<T> extends AbstractMultiSelect<T> implements HasDataProvider<T>
AbstractListing.AbstractListingExtension<T>Component.ErrorEvent, Component.Event, Component.Focusable, Component.ListenerClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListenerSizeable.UnitHasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<V>| Modifier and Type | Field and Description |
|---|---|
protected static int |
DEFAULT_ROWS
Default number of rows visible for select.
|
DESIGN_ATTR_PLAIN_TEXTSIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS| Constructor and Description |
|---|
ListSelect()
Constructs a new ListSelect.
|
ListSelect(String caption)
Constructs a new ListSelect with the given caption.
|
ListSelect(String caption,
Collection<T> options)
Constructs a new ListSelect with caption and the given options.
|
ListSelect(String caption,
DataProvider<T,?> dataProvider)
Constructs a new ListSelect with caption and data provider for options.
|
| Modifier and Type | Method and Description |
|---|---|
DataProvider<T,?> |
getDataProvider()
Returns the source of data items used by this listing.
|
int |
getRows()
Returns the number of rows in the select.
|
protected ListSelectState |
getState()
Returns the shared state bean with information to be sent from the server
to the client.
|
protected ListSelectState |
getState(boolean markAsDirty)
Returns the shared state for this connector.
|
void |
setDataProvider(DataProvider<T,?> dataProvider)
Sets the data provider for this listing.
|
void |
setRows(int rows)
Sets the number of rows in the select.
|
addSelectionListener, addValueChangeListener, deselect, deselect, deselectAll, getCustomAttributes, getItemCaptionGenerator, getItemEnabledProvider, getSelectedItems, getValue, isReadOnly, isRequiredIndicatorVisible, isSelected, readItem, readItems, select, setItemCaptionGenerator, setItemEnabledProvider, setReadOnly, setRequiredIndicatorVisible, setValue, updateSelection, updateSelection, writeItemaddDataGenerator, deserializeDeclarativeRepresentation, doReadDesign, doWriteDesign, focus, getDataCommunicator, getItemIconGenerator, getTabIndex, internalGetDataProvider, internalSetDataProvider, internalSetDataProvider, readDesign, readItem, removeDataGenerator, serializeDeclarativeRepresentation, setItemIconGenerator, setTabIndex, writeDesign, writeItemsaddContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, 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, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthUndefinedaddAttachListener, 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, updateDiffstateclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitsetItemsaddListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesignaddAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandlergetConnectorIdgetHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefineddeselect, getEmptyValue, selectclear, getDefaultValidator, getOptionalValue, isEmptyprotected static final int DEFAULT_ROWS
public ListSelect()
public ListSelect(String caption)
caption - the caption to set, can be nullpublic ListSelect(String caption, DataProvider<T,?> dataProvider)
caption - the caption to set, can be nulldataProvider - the data provider, not nullpublic ListSelect(String caption, Collection<T> options)
caption - the caption to set, can be nulloptions - the options, cannot be nullpublic int getRows()
Default value is DEFAULT_ROWS
public void setRows(int rows)
If a height if set (using AbstractComponent.setHeight(String) or
Sizeable.setHeight(float, Unit)) it overrides the number of rows. Leave
the height undefined to use this method.
Default value is DEFAULT_ROWS
rows - the number of rows to set.protected ListSelectState getState()
AbstractComponentgetState in class AbstractMultiSelect<T>protected ListSelectState getState(boolean markAsDirty)
AbstractClientConnectorgetState in class AbstractMultiSelect<T>markAsDirty - true if the connector should automatically be marked dirty,
false otherwiseAbstractClientConnector.getState()public DataProvider<T,?> getDataProvider()
HasItemsgetDataProvider in interface HasItems<T>public void setDataProvider(DataProvider<T,?> dataProvider)
HasDataProvidersetDataProvider in interface HasDataProvider<T>dataProvider - the data provider, not nullCopyright © 2018 Vaadin Ltd. All rights reserved.