Package com.vaadin.flow.component

Class ScrollOptions

java.lang.Object
com.vaadin.flow.component.ScrollOptions
All Implemented Interfaces:
Serializable
@Deprecated(since="25.0", forRemoval=true) public class ScrollOptions extends Object implements Serializable
Deprecated, for removal: This API element is subject to removal in a future version.
Use Element.scrollIntoView(ScrollIntoViewOption...) with ScrollIntoViewOption.Behavior, ScrollIntoViewOption.Block, and ScrollIntoViewOption.Inline options instead
Options for scrollIntoView.

See https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ScrollOptions.Alignment
    Deprecated, for removal: This API element is subject to removal in a future version.
    Alignment for scrollIntoView.
    static enum 
    ScrollOptions.Behavior
    Deprecated, for removal: This API element is subject to removal in a future version.
    Scroll behavior for scrollIntoView.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScrollOptions()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create an instance with the default options.
    ScrollOptions(ScrollOptions.Behavior behavior)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create an instance with the given scroll behavior.
    ScrollOptions(ScrollOptions.Behavior behavior, ScrollOptions.Alignment block, ScrollOptions.Alignment inline)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create an instance with the given scroll options.

  • Method Summary

    Modifier and Type
    Method
    Description
    ScrollOptions.Behavior
    getBehavior()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the scroll behavior.
    ScrollOptions.Alignment
    getBlock()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the vertical alignment.
    ScrollOptions.Alignment
    getInline()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the horizontal alignment.
    void
    setBehavior(ScrollOptions.Behavior behavior)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the scroll behavior.
    void
    setBlock(ScrollOptions.Alignment block)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the vertical alignment.
    void
    setInline(ScrollOptions.Alignment inline)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the horizontal alignment.
    String
    toJson()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert to json in a form compatible with element.scrollIntoView.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ScrollOptions

      public ScrollOptions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create an instance with the default options.

    • ScrollOptions

      public ScrollOptions(ScrollOptions.Behavior behavior)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create an instance with the given scroll behavior.
      Parameters:
      behavior - the behavior

    • ScrollOptions

      public ScrollOptions(ScrollOptions.Behavior behavior, ScrollOptions.Alignment block, ScrollOptions.Alignment inline)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create an instance with the given scroll options.
      Parameters:
      behavior - the behavior
      block - the vertical alignment
      inline - the horizontal alignment

  • Method Details

    • setBehavior

      public void setBehavior(ScrollOptions.Behavior behavior)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the scroll behavior.
      Parameters:
      behavior - the behavior

    • getBehavior

      public ScrollOptions.Behavior getBehavior()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the scroll behavior.
      Returns:
      the behavior

    • setBlock

      public void setBlock(ScrollOptions.Alignment block)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the vertical alignment.
      Parameters:
      block - the vertical alignment

    • getBlock

      public ScrollOptions.Alignment getBlock()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the vertical alignment.
      Returns:
      the vertical alignment

    • setInline

      public void setInline(ScrollOptions.Alignment inline)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the horizontal alignment.
      Parameters:
      inline - the horizontal alignment

    • getInline

      public ScrollOptions.Alignment getInline()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the horizontal alignment.
      Returns:
      the horizontal alignment

    • toJson

      public String toJson()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Convert to json in a form compatible with element.scrollIntoView.
      Returns:
      a json object as a string