Package 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, FullTextFilter, 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>, WebdavDocumentUploadField
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, FullTextFilterImpl, GroupTableImpl, JpqlFilterImpl, LinkButtonImpl, MaskedFieldImpl, MultiSelectListImpl, PaletteButton, PasswordFieldImpl, PopupButtonImpl, PropertyFilterImpl, RadioButtonGroupImpl, RelatedEntitiesImpl, ResizableTextAreaImpl, RichTextAreaImpl, SearchFieldImpl, SideMenuImpl, SingleSelectListImpl, SourceCodeEditorImpl, SuggestionFieldImpl, TableImpl, TabSheetImpl, TagFieldImpl, TagPickerImpl, TextAreaImpl, TextFieldImpl, TimeFieldImpl, TreeDataGridImpl, TreeImpl, TreeTableImpl, TwinColumnImpl, ValuePickerImpl, ValuesPickerImpl, WebdavDocumentUploadFieldImpl
Enclosing interface:
Component
public static interface Component.Focusable extends Component
Component supporting "focusable" state. Focusable means that component can be focused by TAB button.

  • Method Details

    • 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