com.vaadin.ui
Class TwinColSelect

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractField<java.lang.Object>
              com.vaadin.ui.AbstractSelect
                  com.vaadin.ui.TwinColSelect

All Implemented Interfaces:

Buffered, BufferedValidatable, Container, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.Viewer, Property<java.lang.Object>, Property.Editor, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, Action.ShortcutNotifier, ConnectorEventListener, MethodEventSource, ClientConnector, Sizeable, VariableOwner, com.vaadin.shared.Connector, Component, Component.Focusable, Field<java.lang.Object>, LegacyComponent, java.io.Serializable, java.util.EventListener

public class TwinColSelect
extends AbstractSelect

Multiselect component with two lists: left side for available items and right side for selected items.

See Also:

Serialized Form

Nested Class Summary

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

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

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.server.Sizeable

Sizeable.Unit

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

Field.ValueChangeEvent

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

Buffered.SourceException

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

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

Field Summary

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

TwinColSelect()

TwinColSelect(java.lang.String caption)

TwinColSelect(java.lang.String caption, java.util.Collection<?> options)

TwinColSelect(java.lang.String caption, Container dataSource)

Method Summary

int	getColumns() Deprecated. As of 7.0. "Columns" does not reflect the exact number of characters that will be displayed. It is better to use setWidth together with "em" to control the width of the field.
java.lang.String	getLeftColumnCaption() Returns the text shown above the left column.
java.lang.String	getRightColumnCaption() Returns the text shown above the right column.
int	getRows()
void	paintContent(PaintTarget target) Paints the content of this component.
void	setColumns(int columns) Deprecated. As of 7.0. "Columns" does not reflect the exact number of characters that will be displayed. It is better to use setWidth together with "em" to control the width of the field.
void	setLeftColumnCaption(java.lang.String leftColumnCaption) Sets the text shown above the left column.
void	setRightColumnCaption(java.lang.String rightColumnCaption) Sets the text shown above the right column.
void	setRows(int rows) Sets the number of rows in the editor.

Methods inherited from class com.vaadin.ui.AbstractSelect

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

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, beforeClientResponse, commit, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getState, getState, getTabIndex, getValidators, isBuffered, 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, shouldHideErrors, toString, validate, validate, valueChange

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isConnectorEnabled, isEnabled, isImmediate, isVisible, removeListener, removeShortcutListener, removeStyleName, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setIcon, setId, setImmediate, setParent, setPrimaryStyleName, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hasListeners, isAttached, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

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

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

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

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Constructor Detail

TwinColSelect

public TwinColSelect()

TwinColSelect

public TwinColSelect(java.lang.String caption)

Parameters:

caption -

TwinColSelect

public TwinColSelect(java.lang.String caption,
                     Container dataSource)

Parameters:

caption -

dataSource -

TwinColSelect

public TwinColSelect(java.lang.String caption,
                     java.util.Collection<?> options)

Parameters:

caption -

options -

Method Detail

setColumns

@Deprecated
public void setColumns(int columns)

Deprecated. As of 7.0. "Columns" does not reflect the exact number of characters that will be displayed. It is better to use setWidth together with "em" to control the width of the field.

Sets the width of the component so that it displays approximately the given number of letters in each of the two selects.

Calling setColumns(10); is roughly equivalent to calling setWidth((10*2+4)+"10em");

Parameters:

columns - the number of columns to set.

getColumns

@Deprecated
public int getColumns()

Deprecated. As of 7.0. "Columns" does not reflect the exact number of characters that will be displayed. It is better to use setWidth together with "em" to control the width of the field.

Gets the number of columns for the component.

See Also:

setColumns(int)

getRows

public int getRows()

setRows

public void setRows(int rows)

Sets the number of rows in the editor. If the number of rows is set to 0, the actual number of displayed rows is determined implicitly by the adapter.

If a height if set (using AbstractComponent.setHeight(String) or #setHeight(float, int)) it overrides the number of rows. Leave the height undefined to use this method. This is the opposite of how setColumns(int) work.

Parameters:

rows - the number of rows to set.

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Description copied from class: AbstractSelect

Paints the content of this component.

Specified by:

paintContent in interface LegacyComponent

Overrides:

paintContent in class AbstractSelect

Parameters:

target - the Paint Event.

Throws:

PaintException - if the paint operation failed.

setRightColumnCaption

public void setRightColumnCaption(java.lang.String rightColumnCaption)

Sets the text shown above the right column.

Parameters:

caption - The text to show

getRightColumnCaption

public java.lang.String getRightColumnCaption()

Returns the text shown above the right column.

Returns:

The text shown or null if not set.

setLeftColumnCaption

public void setLeftColumnCaption(java.lang.String leftColumnCaption)

Sets the text shown above the left column.

Parameters:

caption - The text to show

getLeftColumnCaption

public java.lang.String getLeftColumnCaption()

Returns the text shown above the left column.

Returns:

The text shown or null if not set.