Class VScroller

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.orderedlayout.Scroller
org.vaadin.firitin.components.orderedlayout.VScroller
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.orderedlayout.Scroller>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.orderedlayout.Scroller>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.orderedlayout.Scroller>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.orderedlayout.ScrollerVariant>, Serializable, FluentAttachNotifier<VScroller>, FluentComponent<VScroller>, FluentDetachNotifier<VScroller>, FluentHasSize<VScroller>, FluentHasStyle<VScroller>
public class VScroller extends com.vaadin.flow.component.orderedlayout.Scroller implements FluentComponent<VScroller>, FluentHasStyle<VScroller>, FluentHasSize<VScroller>
Extended version of the official Scroller component, with some actual scrolling related methods.
Author:
mstahv
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    VScroller.ScrollEvent
     
    static class 
    VScroller.ScrollToEndEvent
     

    Nested classes/interfaces inherited from class com.vaadin.flow.component.orderedlayout.Scroller

    com.vaadin.flow.component.orderedlayout.Scroller.ScrollDirection

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

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

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

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

  • Constructor Summary

    Constructors
    Constructor
    Description
    VScroller()
     
    VScroller(com.vaadin.flow.component.Component content)
     
    VScroller(com.vaadin.flow.component.Component content, com.vaadin.flow.component.orderedlayout.Scroller.ScrollDirection scrollDirection)
     
    VScroller(com.vaadin.flow.component.orderedlayout.Scroller.ScrollDirection scrollDirection)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addScrollListener(com.vaadin.flow.component.ComponentEventListener<VScroller.ScrollEvent> listener)
     
    com.vaadin.flow.shared.Registration
    addScrollToEndListener(com.vaadin.flow.component.ComponentEventListener<VScroller.ScrollToEndEvent> listener)
    Adds a listener that is called when a users scrolls the component to the end of its scrollable area.
    protected void
    onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
     
    protected void
    onDetach(com.vaadin.flow.component.DetachEvent detachEvent)
     
    void
    scrollIntoView(com.vaadin.flow.component.Component c)
     
    void
    scrollToBottom()
     
    void
    scrollToTop()
     
    void
    setScrollLeft(int pixelsFromLeft)
     
    void
    setScrollTop(int pixelsFromTop)
     

    Methods inherited from class com.vaadin.flow.component.orderedlayout.Scroller

    getContent, getScrollDirection, setContent, setScrollDirection

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

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

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

    addAttachListener

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

    addBlurListener

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

    addDetachListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentAttachNotifier

    withAttachListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentComponent

    setId, setVisible, withId, withVisible

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentDetachNotifier

    withDetachListener

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentHasSize

    addResizeListener, withFullHeight, withFullWidth, withHeight, withMaxHeight, withMaxSize, withMaxWidth, withMinHeight, withMinSize, withMinWidth, withSize, withSizeFull, withSizeUndefined, withWidth

    Methods inherited from interface org.vaadin.firitin.fluency.ui.FluentHasStyle

    withAddedClassName, withClassName, withStyle

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

    addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

    addFocusListener

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

    getElement

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

    isEnabled, setEnabled

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

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

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

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

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

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

    addThemeVariants, removeThemeVariants

  • Constructor Details

    • VScroller

      public VScroller()

    • VScroller

      public VScroller(com.vaadin.flow.component.Component content)

    • VScroller

      public VScroller(com.vaadin.flow.component.Component content, com.vaadin.flow.component.orderedlayout.Scroller.ScrollDirection scrollDirection)

    • VScroller

      public VScroller(com.vaadin.flow.component.orderedlayout.Scroller.ScrollDirection scrollDirection)

  • Method Details

    • onAttach

      protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
      Overrides:
      onAttach in class com.vaadin.flow.component.Component

    • onDetach

      protected void onDetach(com.vaadin.flow.component.DetachEvent detachEvent)
      Overrides:
      onDetach in class com.vaadin.flow.component.Component

    • addScrollToEndListener

      public com.vaadin.flow.shared.Registration addScrollToEndListener(com.vaadin.flow.component.ComponentEventListener<VScroller.ScrollToEndEvent> listener)
      Adds a listener that is called when a users scrolls the component to the end of its scrollable area.
      Parameters:
      listener - the listener
      Returns:
      the Registration you can use to remove this listener.

    • addScrollListener

      public com.vaadin.flow.shared.Registration addScrollListener(com.vaadin.flow.component.ComponentEventListener<VScroller.ScrollEvent> listener)

    • scrollToTop

      public void scrollToTop()
      Overrides:
      scrollToTop in class com.vaadin.flow.component.orderedlayout.Scroller

    • scrollToBottom

      public void scrollToBottom()
      Overrides:
      scrollToBottom in class com.vaadin.flow.component.orderedlayout.Scroller

    • setScrollTop

      public void setScrollTop(int pixelsFromTop)

    • setScrollLeft

      public void setScrollLeft(int pixelsFromLeft)

    • scrollIntoView

      public void scrollIntoView(com.vaadin.flow.component.Component c)