com.vaadin.client.connectors

Class AbstractMultiSelectConnector

java.lang.Object

com.vaadin.client.ui.AbstractConnector

com.vaadin.client.ui.AbstractComponentConnector

com.vaadin.client.ui.AbstractFieldConnector

com.vaadin.client.connectors.AbstractListingConnector

com.vaadin.client.connectors.AbstractMultiSelectConnector

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ComponentConnector, HasDataSource, HasWidget, ServerConnector, HasErrorIndicator, HasRequiredIndicator, Connector, Serializable

Direct Known Subclasses:

ListSelectConnector, TwinColSelectConnector

public abstract class AbstractMultiSelectConnector
extends AbstractListingConnector

A base connector class for multiselects.

Does not care about the framework provided selection model for now, instead just passes selection information per item.

Since:

8.0

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractMultiSelectConnector.MultiSelectWidget Abstraction layer to help populate different multiselect widgets based on same JSON data.

Field Summary

Fields inherited from class com.vaadin.client.ui.AbstractComponentConnector

SIGNIFICANT_MOVE_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
AbstractMultiSelectConnector()

Method Summary

Modifier and Type	Method and Description
abstract AbstractMultiSelectConnector.MultiSelectWidget	getMultiSelectWidget() Returns the multiselect widget for this connector.
AbstractMultiSelectState	getState() Returns the shared state object for this connector.
protected void	init() Called when the connector has been initialized.
boolean	isRequiredIndicatorVisible() Checks if a required indicator should be shown for the given connector.
protected void	onDataChange(Range range) This method handles the parsing of the new JSON data containing the items and the selection information.
void	setDataSource(DataSource<elemental.json.JsonObject> dataSource) Sets the data source for this Connector.

Methods inherited from class com.vaadin.client.connectors.AbstractListingConnector

getDataSource, getRowData, getRowKey, isRowSelected

Methods inherited from class com.vaadin.client.ui.AbstractFieldConnector

isReadOnly, updateWidgetStyleNames

Methods inherited from class com.vaadin.client.ui.AbstractComponentConnector

createWidget, delegateCaptionHandling, flush, getIcon, getIconUri, getLayoutManager, getTooltipInfo, getWidget, hasTooltip, isErrorIndicatorVisible, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onDragSourceAttached, onDragSourceDetached, onDropTargetAttached, onDropTargetDetached, onStateChanged, onUnregister, registerTouchHandlers, sendContextClickEvent, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, shouldHandleLongTap, unregisterTouchHandlers, updateComponentSize, updateComponentSize, updateEnabledState, updateWidgetSize

Methods inherited from class com.vaadin.client.ui.AbstractConnector

addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getParent, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, getTag, hasEventListener, isEnabled, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, setTag, unregisterRpc

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.client.ComponentConnector

delegateCaptionHandling, flush, getLayoutManager, getTooltipInfo, hasTooltip, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, setWidgetEnabled

Methods inherited from interface com.vaadin.client.HasWidget

getWidget

Methods inherited from interface com.vaadin.client.ServerConnector

addStateChangeHandler, addStateChangeHandler, doInit, fireEvent, getChildren, getConnection, getParent, getRpcImplementations, getTag, hasEventListener, isEnabled, onUnregister, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, setTag, updateEnabledState

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

AbstractMultiSelectConnector

public AbstractMultiSelectConnector()

Method Detail

getMultiSelectWidget

public abstract AbstractMultiSelectConnector.MultiSelectWidget getMultiSelectWidget()

Returns the multiselect widget for this connector.

This is used because AbstractComponentConnector.getWidget() returns a class (Widget) instead of an interface (IsWidget), and most multiselects extends Composite.

Returns:

the multiselect widget

init

protected void init()

Description copied from class: AbstractConnector

Called when the connector has been initialized. Override this method to perform initialization of the connector.

Overrides:

init in class AbstractConnector

getState

public AbstractMultiSelectState getState()

Description copied from class: AbstractConnector

Returns the shared state object for this connector. Override this method to define the shared state type for your connector.

Specified by:

getState in interface ComponentConnector

Specified by:

getState in interface ServerConnector

Overrides:

getState in class AbstractListingConnector

Returns:

the current shared state (never null)

setDataSource

public void setDataSource(DataSource<elemental.json.JsonObject> dataSource)

Description copied from interface: HasDataSource

Sets the data source for this Connector.

Specified by:

setDataSource in interface HasDataSource

Overrides:

setDataSource in class AbstractListingConnector

Parameters:

dataSource - the new data source, not null

onDataChange

protected void onDataChange(Range range)

This method handles the parsing of the new JSON data containing the items and the selection information.

Parameters:

range - the updated range, never null

isRequiredIndicatorVisible

public boolean isRequiredIndicatorVisible()

Description copied from interface: HasRequiredIndicator

Checks if a required indicator should be shown for the given connector.

Specified by:

isRequiredIndicatorVisible in interface HasRequiredIndicator

Overrides:

isRequiredIndicatorVisible in class AbstractFieldConnector

Returns:

true to show an indicator, false otherwise