com.vaadin.fluent.api

Interface FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

Type Parameters:

C - Fluent component THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.shared.Connector, FluentComponent<C>, FluentSizeable<C>, Serializable, com.vaadin.server.Sizeable

All Known Subinterfaces:

FluentAbstractColorPicker<THIS>, FluentAbstractDateField<THIS,FIELD,R>, FluentAbstractField<THIS,FIELD>, FluentAbstractFocusable<THIS>, FluentAbstractListing<THIS,ITEM>, FluentAbstractLocalDateField<THIS>, FluentAbstractLocalDateTimeField<THIS>, FluentAbstractMultiSelect<THIS,VALUE>, FluentAbstractSingleSelect<THIS,VALUE>, FluentAbstractTextField<THIS>, FluentButton<THIS>, FluentCheckBox<THIS>, FluentCheckBoxGroup<THIS,VALUE>, FluentComboBox<THIS,ITEM>, FluentCustomField<THIS,T>, FluentDateField<THIS>, FluentDateTimeField<THIS>, FluentGrid<THIS,ITEM>, FluentInlineDateField<THIS>, FluentListSelect<THIS,ITEM>, FluentNativeSelect<THIS,ITEM>, FluentPanel<THIS>, FluentRadioButtonGroup<THIS,ITEM>, FluentRichTextArea<THIS>, FluentSlider<THIS>, FluentTabSheet<THIS>, FluentTextArea<THIS>, FluentTextField<THIS>, FluentTreeGrid<THIS,ITEM>, FluentTwinColSelect<THIS,ITEM>, FluentUpload<THIS>, FluentWindow<THIS>

All Known Implementing Classes:

FAccordion, FButton, FCheckBox, FCheckBoxGroup, FColorPicker, FColorPickerArea, FComboBox, FDateField, FDateTimeField, FGrid, FInlineDateField, FListSelect, FNativeButton, FNativeSelect, FPanel, FPasswordField, FRadioButtonGroup, FRichTextArea, FSlider, FTabSheet, FTextArea, FTextField, FTreeGrid, FTwinColSelect, FUpload, FWindow

Enclosing interface:

FluentComponent<THIS extends FluentComponent<THIS>>

public static interface FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>
extends com.vaadin.ui.Component.Focusable, FluentComponent<C>

A Focusable complemented by fluent setters.

See Also:

Focusable

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

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

Field Summary

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

Method Summary

Modifier and Type	Method and Description
default C	withTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.

Methods inherited from interface com.vaadin.ui.Component.Focusable

focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, 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, 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.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

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

Method Detail

withTabIndex

default C withTabIndex(int tabIndex)

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

 Form loginBox = new Form();
 loginBox.setCaption("Login");
 layout.addComponent(loginBox);

 // Create the first field which will be focused
 TextField username = new TextField("User name");
 loginBox.addField("username", username);

 // Set focus to the user name
 username.focus();

 TextField password = new TextField("Password");
 loginBox.addField("password", password);

 Button login = new Button("Login");
 loginBox.getFooter().addComponent(login);

 // An additional component which natural focus order would
 // be after the button.
 CheckBox remember = new CheckBox("Remember me");
 loginBox.getFooter().addComponent(remember);

 username.setTabIndex(1);
 password.setTabIndex(2);
 remember.setTabIndex(3); // Different than natural place
 login.setTabIndex(4);
 

After all focusable user interface components are done, the browser can begin again from the component with the smallest tab index, or it can take the focus out of the page, for example, to the location bar.

If the tab index is not set (is set to zero), the default tab order is used. The order is somewhat browser-dependent, but generally follows the HTML structure of the page.

A negative value means that the component is completely removed from the tabulation order and can not be reached by pressing the Tab key at all.

Parameters:

tabIndex - the tab order of this component. Indexes usually start from 1. Zero means that default tab order should be used. A negative value means that the field should not be included in the tabbing sequence.

Returns:

this (for method chaining)

See Also:

Component.Focusable.setTabIndex(int)