TokenField (Vaadin 7 compatibility add-on wrappers (parent pom) 1.3.5 API)

java.lang.Object
- com.vaadin.server.AbstractClientConnector
- - com.vaadin.ui.AbstractComponent
  - - com.vaadin.v7.ui.AbstractLegacyComponent
    - - com.vaadin.v7.ui.AbstractField<T>
      - com.vaadin.v7.ui.CustomField
        
        org.vaadin.tokenfield.TokenField

All Implemented Interfaces:

com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.v7.data.Buffered, com.vaadin.v7.data.BufferedValidatable, com.vaadin.v7.data.Container.Editor, com.vaadin.v7.data.Container.Viewer, com.vaadin.v7.data.Property, com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer, com.vaadin.v7.data.Validatable, com.vaadin.v7.ui.Field, Serializable, Iterable<com.vaadin.ui.Component>
```
public class TokenField
extends com.vaadin.v7.ui.CustomField
implements com.vaadin.v7.data.Container.Editor
```
A kind of multiselect ComboBox. When the user selects a token (or inputs a new token, TokenField defaults to allowing new tokens), the value is added as a clickable "token button" before or after the input box. Duplicate selections are not allowed.
TokenField defaults to using CssLayout, but virtually any Layout can be used.

Can be customized in several ways by overriding certain methods. When the user select or enters a new token, the following happens:
- If the token is new (not in the container) and new tokens are not allowed ( setNewTokensAllowed(boolean)), nothing happens - otherwise
- onTokenInput(Object) is called, by default it just calls
- addToken(Object) which will eventually cause a call to
- configureTokenButton(Object, Button)
- finally, if the token is new, it's added to the container if setRememberNewTokens(boolean) is on - this means previous method calls can know whether or not the token is new by examining the container.
Custom functionality when adding and removing tokens, such as showing a notification for duplicates or confirming removal, is done by overriding onTokenInput(Object) and onTokenClick(Object) respectively. In much the same way, #onTokenDelete() is called when the user presses delete or backspace when the input is empty, and can be customized.
The token buttons can be styled customized by overriding #configureTokenButton(TokenField, Object, Button).

The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.

The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.

The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.

The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.

The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.

The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.

The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.
The content of the input (ComboBox) can be bound to a Container datasource, and filtering can be used. Note that the TokenField can select values that are not present in the ComboBox.
Also note that if you use {@link #setTokenCaptionPropertyId(Object)} (to use a specific property as token caption) AND allow new tokens to be input ( {@link #setNewTokensAllowed(boolean)}, you should probably use a custom {@link NewItemHandler) ({@link #setNewTokenHandler(NewItemHandler)}) in order to provide a sensible caption for the new token.

TokenField is a full-fledged field - it can be bound to a Property datasource, and supports buffering.

Note "token" and "tokenId" is often used interchangeably in the documentation - usually the token is just a string that is the id as well. The term Token as used in the method names is often interchangeable with the term item seen elsewhere in the Vaadin API; e.g {@link #setTokenCaption(Object, String)} works exactly as {@link ComboBox#setItemCaption(Object, String)}, and tokenId is the same as itemId.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TokenField.InsertPosition
- Nested classes/interfaces inherited from class com.vaadin.v7.ui.AbstractField
  com.vaadin.v7.ui.AbstractField.FocusShortcut, com.vaadin.v7.ui.AbstractField.ReadOnlyStatusChangeEvent
- Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents
  com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener
- Nested classes/interfaces inherited from interface com.vaadin.ui.Component
  com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener
- Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
  com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener
- Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
  com.vaadin.server.Sizeable.Unit
- Nested classes/interfaces inherited from interface com.vaadin.v7.ui.Field
  com.vaadin.v7.ui.Field.ValueChangeEvent
- Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered
  com.vaadin.v7.data.Buffered.SourceException
- Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property
  com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyException, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.Transactional<T>, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer

Nested Classes
Modifier and Type	Class and Description
`static class`	`TokenField.InsertPosition`

Field Summary

Fields
Modifier and Type	Field and Description
`protected LinkedHashMap<Object,com.vaadin.ui.Button>`	`buttons` Maps the tokenId (itemId) to the token button
`protected TokenComboBox`	`cb` The ComboBox used for input - should probably not be touched.
`protected TokenField.InsertPosition`	`insertPosition` Current insert position
`protected com.vaadin.ui.Layout`	`layout` The layout currently in use
`protected boolean`	`rememberNewTokens`
`static String`	`STYLE_BUTTON_EMPHAZISED`
`static String`	`STYLE_TOKENFIELD`
`static String`	`STYLE_TOKENTEXTFIELD`

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 and Description
`TokenField()` Create a new TokenField.
`TokenField(com.vaadin.ui.Layout lo)` Create a new TokenField with the given layout.
`TokenField(com.vaadin.ui.Layout lo, TokenField.InsertPosition insertPosition)` Create a new TokenField with the given layout, and the specified token insert position.
`TokenField(String caption)` Create a new TokenField with a caption.
`TokenField(String caption, com.vaadin.ui.Layout lo)` Create a new TokenField with a caption and a given layout.
`TokenField(String caption, com.vaadin.ui.Layout lo, TokenField.InsertPosition insertPosition)` Create a new TokenField with a caption, a given layout, and the specified token insert position.
`TokenField(String caption, TokenField.InsertPosition insertPosition)` Create a new TokenField with a caption and a `TokenField.InsertPosition`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToken(Object tokenId)` Adds a token if that token does not already exist.
`protected void`	`configureTokenButton(Object tokenId, com.vaadin.ui.Button button)` Configures the token button.
`void`	`focus()`
`com.vaadin.v7.data.Container`	`getContainerDataSource()` Gets the Container data source currently used for the input box.
`com.vaadin.v7.shared.ui.combobox.FilteringMode`	`getFilteringMode()` Works as `ComboBox.getFilteringMode()`.
`String`	`getInputPrompt()` Gets the input prompt; works as `ComboBox.getInputPrompt()`.
`com.vaadin.ui.Layout`	`getLayout()` Gets the layout currently in use.
`int`	`getTabIndex()`
`String`	`getTokenCaption(Object tokenId)` Gets the caption for the given token; the caption can be based on a property, just as in a ComboBox.
`com.vaadin.v7.ui.AbstractSelect.ItemCaptionMode`	`getTokenCaptionMode()`
`Object`	`getTokenCaptionPropertyId()`
`com.vaadin.server.Resource`	`getTokenIcon(Object tokenId)`
`Object`	`getTokenIconPropertyId()`
`Collection`	`getTokenIds()` Gets all tokenIds currently in the token container.
`TokenField.InsertPosition`	`getTokenInsertPosition()` Gets the current token `TokenField.InsertPosition`. The token buttons are be placed at this position, relative to the input box.
`Class<?>`	`getType()`
`protected com.vaadin.ui.Component`	`initContent()`
`boolean`	`isNewTokensAllowed()` Checks whether or not new tokens are allowed
`boolean`	`isRememberNewTokens()` If true, new tokens entered by the user are automatically added to the container.
`protected void`	`onTokenClick(Object tokenId)` Called when the token button is clicked, which by default removes the token by calling `removeToken(Object)`.
`protected void`	`onTokenDelete(Object tokenId)` Called with the last added token when the delete or backspace -key (depending in insert position) is pressed in an empty input.
`protected void`	`onTokenInput(Object tokenId)` Called when the user is adding a new token via the UI; called after the newItemHandler.
`protected void`	`rememberToken(String tokenId)`
`void`	`removeToken(Object tokenId)` Removes the given token.
`void`	`setContainerDataSource(com.vaadin.v7.data.Container c)` Sets the Container data source used for the input box.
`void`	`setFilteringMode(com.vaadin.v7.shared.ui.combobox.FilteringMode filteringMode)` Works as `ComboBox#setFilteringMode(int)`.
`void`	`setHeight(float height, com.vaadin.server.Sizeable.Unit unit)`
`void`	`setInputHeight(float height, com.vaadin.server.Sizeable.Unit unit)`
`void`	`setInputHeight(String height)`
`void`	`setInputPrompt(String inputPrompt)` Sets the input prompt; works as `ComboBox.setInputPrompt(String)`.
`void`	`setInputSizeFull()`
`void`	`setInputSizeUndefined()`
`void`	`setInputWidth(float width, com.vaadin.server.Sizeable.Unit unit)`
`void`	`setInputWidth(String width)`
`protected void`	`setInternalValue(Object newValue)`
`protected void`	`setLayout(com.vaadin.ui.Layout newLayout)` Sets layout used for laying out the tokens and the input.
`void`	`setNewTokensAllowed(boolean allowNewTokens)` Sets whether or not tokens entered by the user that not present in the container are allowed.
`void`	`setReadOnly(boolean readOnly)`
`void`	`setRememberNewTokens(boolean rememberNewTokens)` Provided new tokens are allowed (`setNewTokensAllowed(boolean)`), this sets whether or not new tokens entered by the user are automatically added to the container.
`void`	`setSizeFull()`
`void`	`setSizeUndefined()`
`void`	`setTabIndex(int tabIndex)`
`void`	`setTokenCaption(Object tokenId, String caption)` sets the caption for the given token.
`void`	`setTokenCaptionMode(com.vaadin.v7.ui.AbstractSelect.ItemCaptionMode mode)`
`void`	`setTokenCaptionPropertyId(Object propertyId)`
`void`	`setTokenIcon(Object tokenId, com.vaadin.server.Resource icon)`
`void`	`setTokenIconPropertyId(Object propertyId)`
`void`	`setTokenInsertPosition(TokenField.InsertPosition insertPosition)` Sets the token `TokenField.InsertPosition`. The token buttons will be placed at this position, relative to the input box.
`void`	`setWidth(float width, com.vaadin.server.Sizeable.Unit unit)`

Methods inherited from class com.vaadin.v7.ui.CustomField
attach, getContent, iterator, setFocusDelegate

Methods inherited from class com.vaadin.v7.ui.AbstractField
addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, beforeClientResponse, clear, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getState, getState, getValidators, getValue, isBuffered, isEmpty, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readDesign, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setRequired, setRequiredError, setValidationVisible, setValue, setValue, setValue, shouldHideErrors, validate, validate, valueChange, writeDesign

Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent
getExplicitImmediateValue, isImmediate, setImmediate

Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setStyleName, setVisible, 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, 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, updateDiffstate

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, 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, setHeightUndefined, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier
addShortcutListener, removeShortcutListener

- Field Detail
  - STYLE_TOKENFIELD
```
public static final String STYLE_TOKENFIELD
```
    See Also:
    
    Constant Field Values
  - STYLE_TOKENTEXTFIELD
```
public static final String STYLE_TOKENTEXTFIELD
```
    See Also:
    
    Constant Field Values
  - STYLE_BUTTON_EMPHAZISED
```
public static final String STYLE_BUTTON_EMPHAZISED
```
    See Also:
    
    Constant Field Values
  - layout
```
protected com.vaadin.ui.Layout layout
```
    The layout currently in use
  - insertPosition
```
protected TokenField.InsertPosition insertPosition
```
    Current insert position
  - cb
```
protected TokenComboBox cb
```
    The ComboBox used for input - should probably not be touched.
  - buttons
```
protected LinkedHashMap<Object,com.vaadin.ui.Button> buttons
```
    Maps the tokenId (itemId) to the token button
  - rememberNewTokens
```
protected boolean rememberNewTokens
```
- Constructor Detail
  - TokenField
```
public TokenField(String caption,
                  TokenField.InsertPosition insertPosition)
```
    Create a new TokenField with a caption and a TokenField.InsertPosition.
    
    Parameters:
    
    caption - the desired caption
    
    insertPosition - the desired insert position
  - TokenField
```
public TokenField(String caption)
```
    Create a new TokenField with a caption.
    
    Parameters:
    
    caption - the desired caption
  - TokenField
```
public TokenField()
```
    Create a new TokenField.
  - TokenField
```
public TokenField(String caption,
                  com.vaadin.ui.Layout lo)
```
    Create a new TokenField with a caption and a given layout.
    
    Parameters:
    
    caption - the desired caption
    
    lo - the desired layout
  - TokenField
```
public TokenField(String caption,
                  com.vaadin.ui.Layout lo,
                  TokenField.InsertPosition insertPosition)
```
    Create a new TokenField with a caption, a given layout, and the specified token insert position.
    
    Parameters:
    
    caption - the desired caption
    
    lo - the desired layout
    
    insertPosition - the desired token insert position
  - TokenField
```
public TokenField(com.vaadin.ui.Layout lo,
                  TokenField.InsertPosition insertPosition)
```
    Create a new TokenField with the given layout, and the specified token insert position.
    
    Parameters:
    
    lo - the desired layout
    
    insertPosition - the desired token insert position
  - TokenField
```
public TokenField(com.vaadin.ui.Layout lo)
```
    Create a new TokenField with the given layout.
    
    Parameters:
    
    lo - the desired layout
- Method Detail
  - rememberToken
```
protected void rememberToken(String tokenId)
```
  - setInternalValue
```
protected void setInternalValue(Object newValue)
```
    Overrides:
    
    setInternalValue in class com.vaadin.v7.ui.AbstractField
  - onTokenInput
```
protected void onTokenInput(Object tokenId)
```
    Called when the user is adding a new token via the UI; called after the newItemHandler. Can be used to make customize the adding process; e.g to notify that the token was not added because it's duplicate, to ask for additional information, or to disallow addition due to some heuristics (not both A and Q).
    The default is to call addToken(Object) which will add the token if it's not a duplicate.
    
    Parameters:
    
    tokenId - the token id selected (or input)
  - onTokenClick
```
protected void onTokenClick(Object tokenId)
```
    Called when the token button is clicked, which by default removes the token by calling removeToken(Object). The behavior can be customized, e.g present a confirmation dialog.
    
    Parameters:
    
    tokenId - the id of the token that was clicked
  - onTokenDelete
```
protected void onTokenDelete(Object tokenId)
```
    Called with the last added token when the delete or backspace -key (depending in insert position) is pressed in an empty input. The default is to call onTokenClick(Object) with the last added token, i.e remove last. The behavior can be customized, e.g present a confirmation dialog.
  - addToken
```
public void addToken(Object tokenId)
```
    Adds a token if that token does not already exist.
    Note that tokens are not automatically added to the token container. This means you can add tokens without adding them to the container (that might be bound to some data store), and without making them available to the user in the suggestion dropdown.
    This also means that when new tokens are disallowed ( setNewTokensAllowed(boolean)) you can programmatically add tokens that the user can not add him/herself.
    Consider adding the token to the container before calling addToken(Object) if you're using a custom captions based on container/item properties, or if you want the token to be available to the user as a suggestion later.
    
    Parameters:
    
    tokenId - the token to add
  - removeToken
```
public void removeToken(Object tokenId)
```
    Removes the given token.
    Note that the token is not removed from the container, so if it exists in the container, the token will still be available to the user.
    
    Parameters:
    
    tokenId - the token to remove
  - configureTokenButton
```
protected void configureTokenButton(Object tokenId,
                                    com.vaadin.ui.Button button)
```
    Configures the token button.
    By default, the caption, icon, description, and style is set. Override to customize.
    Note that the default click-listener is added elsewhere and can not be changed here.
    
    Parameters:
    
    tokenId - the token this button pertains to
    
    button - the button to be configured
  - getLayout
```
public com.vaadin.ui.Layout getLayout()
```
    Gets the layout currently in use.
    
    Returns:
    
    the current layout
  - setLayout
```
protected void setLayout(com.vaadin.ui.Layout newLayout)
```
    Sets layout used for laying out the tokens and the input.
    
    Parameters:
    
    newLayout - the layout to use
  - getTokenInsertPosition
```
public TokenField.InsertPosition getTokenInsertPosition()
```
    Gets the current token TokenField.InsertPosition.
    The token buttons are be placed at this position, relative to the input box.
    
    Returns:
    
    the current token insert position
    
    See Also:
    
    setTokenInsertPosition(InsertPosition), TokenField.InsertPosition
  - setTokenInsertPosition
```
public void setTokenInsertPosition(TokenField.InsertPosition insertPosition)
```
    Sets the token TokenField.InsertPosition.
    The token buttons will be placed at this position, relative to the input box.
    
    See Also:
    
    getTokenInsertPosition(), TokenField.InsertPosition
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Specified by:
    
    setReadOnly in interface com.vaadin.v7.data.Property
    
    Overrides:
    
    setReadOnly in class com.vaadin.v7.ui.AbstractField
  - setContainerDataSource
```
public void setContainerDataSource(com.vaadin.v7.data.Container c)
```
    Sets the Container data source used for the input box. This works exactly as AbstractSelect.setContainerDataSource(Container).
    
    Specified by:
    
    setContainerDataSource in interface com.vaadin.v7.data.Container.Viewer
    
    Parameters:
    
    c - the token container data source
    
    See Also:
    
    AbstractSelect.setContainerDataSource(Container)
  - getContainerDataSource
```
public com.vaadin.v7.data.Container getContainerDataSource()
```
    Gets the Container data source currently used for the input box. This works exactly as AbstractSelect.getContainerDataSource().
    
    Specified by:
    
    getContainerDataSource in interface com.vaadin.v7.data.Container.Viewer
    
    Returns:
    
    the container used to tokens
    
    See Also:
    
    AbstractSelect.getContainerDataSource()
  - setNewTokensAllowed
```
public void setNewTokensAllowed(boolean allowNewTokens)
```
    Sets whether or not tokens entered by the user that not present in the container are allowed. When true, the token is added, and if setRememberNewTokens(boolean) is true, the new token will be added to the container as well.
    
    Parameters:
    
    allowNewTokens - true to allow tokens that are not in the container
    
    See Also:
    
    #setNewTokenHandler(NewItemHandler)
  - isNewTokensAllowed
```
public boolean isNewTokensAllowed()
```
    Checks whether or not new tokens are allowed
    
    Returns:
    
    See Also:
    
    setNewTokensAllowed(boolean)
  - isRememberNewTokens
```
public boolean isRememberNewTokens()
```
    If true, new tokens entered by the user are automatically added to the container.
    
    Returns:
    
    true if tokens are automatically added
  - setRememberNewTokens
```
public void setRememberNewTokens(boolean rememberNewTokens)
```
    Provided new tokens are allowed (setNewTokensAllowed(boolean)), this sets whether or not new tokens entered by the user are automatically added to the container.
    
    Parameters:
    
    rememberNewTokens - true to add new tokens automatically
  - setFilteringMode
```
public void setFilteringMode(com.vaadin.v7.shared.ui.combobox.FilteringMode filteringMode)
```
    Works as ComboBox#setFilteringMode(int).
    
    Parameters:
    
    filteringMode - the desired filtering mode
    
    See Also:
    
    ComboBox#setFilteringMode(int)
  - getFilteringMode
```
public com.vaadin.v7.shared.ui.combobox.FilteringMode getFilteringMode()
```
    Works as ComboBox.getFilteringMode().
    
    Parameters:
    
    filteringMode - the desired filtering mode
    
    See Also:
    
    ComboBox.getFilteringMode()
  - focus
```
public void focus()
```
    Specified by:
    
    focus in interface com.vaadin.ui.Component.Focusable
    
    Overrides:
    
    focus in class com.vaadin.v7.ui.CustomField
  - getInputPrompt
```
public String getInputPrompt()
```
    Gets the input prompt; works as ComboBox.getInputPrompt().
    
    Returns:
    
    the current input prompt
    
    See Also:
    
    ComboBox.getInputPrompt()
  - getTokenCaption
```
public String getTokenCaption(Object tokenId)
```
    Gets the caption for the given token; the caption can be based on a property, just as in a ComboBox. Note that the string representation of the tokenId itself is always used if the container does not contain the id.
    
    Parameters:
    
    tokenId - the id of the token
    
    Returns:
    
    the caption
  - getTokenCaptionMode
```
public com.vaadin.v7.ui.AbstractSelect.ItemCaptionMode getTokenCaptionMode()
```
    Returns:
    
    the current caption mode
    
    See Also:
    
    AbstractSelect.getItemCaptionMode()
  - getTokenCaptionPropertyId
```
public Object getTokenCaptionPropertyId()
```
    Returns:
    
    the current caption property id
    
    See Also:
    
    AbstractSelect.getItemCaptionPropertyId()
  - getTokenIcon
```
public com.vaadin.server.Resource getTokenIcon(Object tokenId)
```
    Returns:
    
    the icon for the given resource
    
    See Also:
    
    AbstractSelect.getItemIcon(Object)
  - getTokenIconPropertyId
```
public Object getTokenIconPropertyId()
```
    Returns:
    
    the current item icon property id
    
    See Also:
    
    AbstractSelect.getItemIconPropertyId()
  - getTokenIds
```
public Collection getTokenIds()
```
    Gets all tokenIds currently in the token container.
    
    Returns:
    
    a collection of all tokenIds in the container
  - getTabIndex
```
public int getTabIndex()
```
    Specified by:
    
    getTabIndex in interface com.vaadin.ui.Component.Focusable
    
    Overrides:
    
    getTabIndex in class com.vaadin.v7.ui.CustomField
  - setHeight
```
public void setHeight(float height,
                      com.vaadin.server.Sizeable.Unit unit)
```
    Specified by:
    
    setHeight in interface com.vaadin.server.Sizeable
    
    Overrides:
    
    setHeight in class com.vaadin.v7.ui.CustomField
  - setWidth
```
public void setWidth(float width,
                     com.vaadin.server.Sizeable.Unit unit)
```
    Specified by:
    
    setWidth in interface com.vaadin.server.Sizeable
    
    Overrides:
    
    setWidth in class com.vaadin.v7.ui.CustomField
  - setSizeFull
```
public void setSizeFull()
```
    Specified by:
    
    setSizeFull in interface com.vaadin.server.Sizeable
    
    Overrides:
    
    setSizeFull in class com.vaadin.ui.AbstractComponent
  - setSizeUndefined
```
public void setSizeUndefined()
```
    Specified by:
    
    setSizeUndefined in interface com.vaadin.server.Sizeable
    
    Overrides:
    
    setSizeUndefined in class com.vaadin.ui.AbstractComponent
  - setInputHeight
```
public void setInputHeight(String height)
```
  - setInputWidth
```
public void setInputWidth(String width)
```
  - setInputHeight
```
public void setInputHeight(float height,
                           com.vaadin.server.Sizeable.Unit unit)
```
  - setInputWidth
```
public void setInputWidth(float width,
                          com.vaadin.server.Sizeable.Unit unit)
```
  - setInputSizeFull
```
public void setInputSizeFull()
```
  - setInputSizeUndefined
```
public void setInputSizeUndefined()
```
  - setInputPrompt
```
public void setInputPrompt(String inputPrompt)
```
    Sets the input prompt; works as ComboBox.setInputPrompt(String).
    
    See Also:
    
    ComboBox.setInputPrompt(String)
  - setTokenCaption
```
public void setTokenCaption(Object tokenId,
                            String caption)
```
    sets the caption for the given token.
    
    Parameters:
    
    tokenId - token whose caption to set
    
    caption - the desired caption
    
    See Also:
    
    AbstractSelect.setItemCaption(Object, String)
  - setTokenCaptionMode
```
public void setTokenCaptionMode(com.vaadin.v7.ui.AbstractSelect.ItemCaptionMode mode)
```
    Parameters:
    
    mode -
    
    See Also:
    
    ComboBox#setItemCaptionMode(int)
  - setTokenCaptionPropertyId
```
public void setTokenCaptionPropertyId(Object propertyId)
```
    Parameters:
    
    propertyId -
    
    See Also:
    
    AbstractSelect.setItemCaptionPropertyId(Object)
  - setTokenIcon
```
public void setTokenIcon(Object tokenId,
                         com.vaadin.server.Resource icon)
```
    Parameters:
    
    tokenId -
    
    icon -
    
    See Also:
    
    AbstractSelect.setItemIcon(Object, Resource)
  - setTokenIconPropertyId
```
public void setTokenIconPropertyId(Object propertyId)
```
    Parameters:
    
    propertyId -
    
    See Also:
    
    AbstractSelect.setItemIconPropertyId(Object)
  - setTabIndex
```
public void setTabIndex(int tabIndex)
```
    Specified by:
    
    setTabIndex in interface com.vaadin.ui.Component.Focusable
    
    Overrides:
    
    setTabIndex in class com.vaadin.v7.ui.CustomField
  - getType
```
public Class<?> getType()
```
    Specified by:
    
    getType in interface com.vaadin.v7.data.Property
    
    Specified by:
    
    getType in class com.vaadin.v7.ui.AbstractField
  - initContent
```
protected com.vaadin.ui.Component initContent()
```
    Specified by:
    
    initContent in class com.vaadin.v7.ui.CustomField

Class TokenField

Nested Class Summary

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

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

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

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

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

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

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

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

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

Fields inherited from interface com.vaadin.server.Sizeable

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.v7.ui.CustomField

Methods inherited from class com.vaadin.v7.ui.AbstractField

Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent

Methods inherited from class com.vaadin.ui.AbstractComponent

Methods inherited from class com.vaadin.server.AbstractClientConnector

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.ui.Component

Methods inherited from interface com.vaadin.server.ClientConnector

Methods inherited from interface com.vaadin.shared.Connector

Methods inherited from interface com.vaadin.server.Sizeable

Methods inherited from interface java.lang.Iterable

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

Field Detail

STYLE_TOKENFIELD

STYLE_TOKENTEXTFIELD

STYLE_BUTTON_EMPHAZISED

layout

insertPosition

cb

buttons

rememberNewTokens

Constructor Detail

TokenField

TokenField

TokenField

TokenField

TokenField

TokenField

TokenField

Method Detail

rememberToken

setInternalValue

onTokenInput

onTokenClick

onTokenDelete

addToken

removeToken

configureTokenButton

getLayout

setLayout

getTokenInsertPosition

setTokenInsertPosition

setReadOnly

setContainerDataSource

getContainerDataSource

setNewTokensAllowed

isNewTokensAllowed

isRememberNewTokens

setRememberNewTokens

setFilteringMode

getFilteringMode

focus

getInputPrompt

getTokenCaption

getTokenCaptionMode

getTokenCaptionPropertyId

getTokenIcon

getTokenIconPropertyId

getTokenIds

getTabIndex

setHeight

setWidth

setSizeFull

setSizeUndefined

setInputHeight