Package com.vaadin.flow.component

Interface FocusOption

All Superinterfaces:
Serializable
All Known Implementing Classes:
FocusOption.FocusVisible, FocusOption.PreventScroll
public interface FocusOption extends Serializable
Marker interface for focus options.

Implementations of this interface can be passed to Focusable.focus(FocusOption...).

See HTMLElement.focus() for more information.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    FocusOption.FocusVisible
    Focus visibility option for focus operations.
    static enum 
    FocusOption.PreventScroll
    Scroll prevention option for focus operations.

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static tools.jackson.databind.node.ObjectNode
    buildOptions(FocusOption... options)
    Builds an ObjectNode containing the focus options for use with the browser's focus() method.

  • Method Details

    • buildOptions

      static tools.jackson.databind.node.ObjectNode buildOptions(FocusOption... options)
      Builds an ObjectNode containing the focus options for use with the browser's focus() method.

      This method extracts FocusVisible and PreventScroll options from the varargs and builds a JSON object compatible with the browser's HTMLElement.focus() API. Returns null if all options are at their default values.

      Parameters:
      options - zero or more focus options
      Returns:
      an ObjectNode with the focus options, or null if all options are default