io.jmix.ui.component

Interface Component.Focusable

All Superinterfaces:

Component

All Known Subinterfaces:

Accordion, AppMenu, Button, CheckBox, CheckBoxGroup<I>, ColorPicker, ComboBox<V>, CurrencyField<V>, DataGrid<E>, DateField<V>, DatePicker<V>, EntityComboBox<V>, EntityLinkField<V>, EntityPicker<V>, EntitySuggestionField<V>, FileMultiUploadField, FileStorageUploadField, FileUploadField, GroupTable<E>, JpqlFilter<V>, LinkButton, MaskedField<V>, MultiSelectList<V>, PasswordField, PopupButton, PropertyFilter<V>, RadioButtonGroup<I>, RelatedEntities<E>, ResizableTextArea<V>, RichTextArea, SelectList<V,I>, SideMenu, SingleFileUploadField, SingleFilterComponent<V>, SingleSelectList<V>, SourceCodeEditor, SuggestionField<V>, SuggestionFieldComponent<V,I>, Table<E>, TabSheet, TagField<V>, TagPicker<V>, TextArea<V>, TextField<V>, TextInputField<V>, TimeField<V>, Tree<E>, TreeDataGrid<E>, TreeTable<E>, TwinColumn<V>, UploadField, ValuePicker<V>, ValuesPicker<V>

All Known Implementing Classes:

AbstractDataGrid, AbstractFileStorageUploadField, AbstractSelectList, AbstractSingleFileUploadField, AbstractSingleFilterComponent, AbstractSuggestionField, AbstractTable, AbstractTextArea, AccordionImpl, AppMenuImpl, ButtonImpl, CheckBoxGroupImpl, CheckBoxImpl, ColorPickerImpl, ComboBoxImpl, CurrencyFieldImpl, DataGridImpl, DateFieldImpl, DatePickerImpl, EntityComboBoxImpl, EntityLinkFieldImpl, EntityPickerImpl, EntitySuggestionFieldImpl, FileMultiUploadFieldImpl, FileStorageUploadFieldImpl, FileUploadFieldImpl, GroupTableImpl, JpqlFilterImpl, LinkButtonImpl, MaskedFieldImpl, MultiSelectListImpl, PasswordFieldImpl, PopupButtonImpl, PropertyFilterImpl, RadioButtonGroupImpl, RelatedEntitiesImpl, ResizableTextAreaImpl, RichTextAreaImpl, SideMenuImpl, SingleSelectListImpl, SourceCodeEditorImpl, SuggestionFieldImpl, TableImpl, TabSheetImpl, TagFieldImpl, TagPickerImpl, TextAreaImpl, TextFieldImpl, TimeFieldImpl, TreeDataGridImpl, TreeImpl, TreeTableImpl, TwinColumnImpl, ValuePickerImpl, ValuesPickerImpl

Enclosing interface:

Component

public static interface Component.Focusable
extends Component

Component supporting "focusable" state. Focusable means that component can be focused by TAB button.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Field Summary

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
void	focus() Sets focus to this component
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
default boolean	isFocusable()
default void	setFocusable(boolean focusable) Sets whether this component should be focusable, i.e.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Method Detail

focus

void focus()

Sets focus to this component

isFocusable

default boolean isFocusable()

Returns:

whether this component should be focusable

setFocusable

default void setFocusable(boolean focusable)

Sets whether this component should be focusable, i.e. sets tabulator index to 0 if true, -1 otherwise.

Parameters:

focusable - whether this component should be focusable

getTabIndex

int getTabIndex()

Gets the tabulator index of the HasTabIndex component.

Returns:

tab index set for the HasTabIndex component

setTabIndex

@StudioProperty(defaultValue="0")
void setTabIndex(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.

Parameters:

tabIndex - tab index