com.vaadin.flow.component

Interface Focusable<T extends Component>

Type Parameters:

T - the type of the component which implements the interface

All Superinterfaces:

BlurNotifier<T>, FocusNotifier<T>, HasElement, HasEnabled, Serializable

All Known Implementing Classes:

AbstractNumberField, Anchor, BigDecimalField, Button, Checkbox, ComboBox, CrudGrid, CustomField, DatePicker, DateTimePicker, DrawerToggle, EmailField, GeneratedVaadinButton, GeneratedVaadinCheckbox, GeneratedVaadinComboBox, GeneratedVaadinDatePicker, GeneratedVaadinEmailField, GeneratedVaadinNumberField, GeneratedVaadinPasswordField, GeneratedVaadinRadioButton, GeneratedVaadinSelect, GeneratedVaadinTextArea, GeneratedVaadinTextField, GeneratedVaadinTimePicker, Grid, GridPro, Input, IntegerField, IronList, NativeButton, NumberField, PasswordField, RouterLink, Select, TextArea, TextField, TimePicker, TreeGrid

public interface Focusable<T extends Component>
extends HasElement, BlurNotifier<T>, FocusNotifier<T>, HasEnabled

Represents a component that can gain and lose focus.

Since:

1.0

Author:

Vaadin Ltd.

See Also:

BlurNotifier, FocusNotifier

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

BlurNotifier.BlurEvent<C extends Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

FocusNotifier.FocusEvent<C extends Component>

Method Summary

Modifier and Type	Method and Description
default ShortcutRegistration	addFocusShortcut(Key key, KeyModifier... keyModifiers) Adds a shortcut which focuses the Component which implements Focusable interface.
default void	blur() Calls the blur function at the client, making the component lose keyboard focus.
default void	focus() Calls the focus function at the client, making the component keyboard focused.
default int	getTabIndex() Gets the tabindex in the component.
default void	setTabIndex(int tabIndex) Sets the tabindex attribute in the component.

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Method Detail

setTabIndex

default void setTabIndex(int tabIndex)

Sets the tabindex attribute in the component. The tabIndex indicates if its element can be focused, and if/where it participates in sequential keyboard navigation:

• A negative value (usually tabindex = -1 means that the component should be focusable, but should not be reachable via sequential keyboard navigation.
• tabindex = 0 means that the component should be focusable in sequential keyboard navigation, but its order is defined by the document's source order.
• A positive value means the component should be focusable in sequential keyboard navigation, with its order defined by the value of the number. That is, tabindex = 4 would be focused before tabindex = 5, but after tabindex = 3. If multiple components share the same positive tabindex value, their order relative to each other follows their position in the document source.

Parameters:

tabIndex - the tabindex attribute

See Also:

tabindex at MDN

getTabIndex

default int getTabIndex()

Gets the tabindex in the component. The tabIndex indicates if its element can be focused, and if/where it participates in sequential keyboard navigation.

If there's no such attribute set, it returns the default setting for the element, which depends on the element and on the browser. If the attribute cannot be parsed to int, then an IllegalStateException is thrown.

Returns:

the tabindex attribute, or 0 if none

Throws:

IllegalStateException - if the returned tabindex from the element is empty or can not be parsed to int

See Also:

tabindex at MDN

focus

default void focus()

Calls the focus function at the client, making the component keyboard focused.

See Also:

focus at MDN

blur

default void blur()

Calls the blur function at the client, making the component lose keyboard focus.

See Also:

blur at MDN

addFocusShortcut

default ShortcutRegistration addFocusShortcut(Key key,
                                              KeyModifier... keyModifiers)

Adds a shortcut which focuses the Component which implements Focusable interface. The shortcut's event listener is in global scope and the shortcut's lifecycle is tied to this component.

Use the returned ShortcutRegistration to fluently configure the shortcut.

Parameters:

key - primary Key used to trigger the shortcut. Cannot be null.

keyModifiers - KeyModifiers that need to be pressed along with the key for the shortcut to trigger

Returns:

ShortcutRegistration for configuring the shortcut and removing