com.vaadin.flow.component.orderedlayout.Scroller API 24.7.0.alpha6 | Vaadin

com.vaadin.flow.component.orderedlayout.

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.orderedlayout.Scroller

All Implemented Interfaces:

AttachNotifier, BlurNotifier<Scroller>, DetachNotifier, Focusable<Scroller>, FocusNotifier<Scroller>, HasElement, HasEnabled, HasSize, HasStyle, HasTheme, HasThemeVariant<ScrollerVariant>, Serializable

@Tag("vaadin-scroller") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.7.0-alpha7") @NpmPackage(value="@vaadin/scroller",version="24.7.0-alpha7") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/scroller/src/vaadin-scroller.js") public class Scroller extends Component implements Focusable<Scroller>, HasSize, HasStyle, HasThemeVariant<ScrollerVariant>

Scroller is a component container which enables scrolling overflowing content. Scroll direction can be configured with setScrollDirection(ScrollDirection)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

Scroller.ScrollDirection

Enum for the values of the ScrollDirection property.

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>
Constructor Summary

Constructors

Constructor

Description

Scroller()

Constructs an empty scroller.

Scroller(Component content)

Convenience constructor to create a scroller with the given content.

Scroller(Component content, Scroller.ScrollDirection scrollDirection)

Convenience constructor to create a scroller with the given content and scroll direction.

Scroller(Scroller.ScrollDirection scrollDirection)

Convenience constructor to create an empty scroller with the given scroll direction.
Method Summary

Modifier and Type

Method

Description

Component

getContent()

Gets the content of this scroller.

Scroller.ScrollDirection

getScrollDirection()

Returns the scroll direction for this scroller.

void

scrollToBottom()

Scrolls the scroller to the bottom.

void

scrollToTop()

Scrolls the scroller to the top.

void

setContent(Component content)

Sets the content of this scroller.

void

setScrollDirection(Scroller.ScrollDirection scrollDirection)

Sets the scroll direction for this scroller.

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, onAttach, onDetach, 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 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
- Scroller
  
  public Scroller()
  
  Constructs an empty scroller. Content can be set with setContent(Component) and scroll direction defaults to Scroller.ScrollDirection.BOTH and can be set with setScrollDirection(ScrollDirection).
- Scroller
  
  public Scroller(Component content)
  
  Convenience constructor to create a scroller with the given content. Scroll direction defaults to Scroller.ScrollDirection.BOTH and can be set with setScrollDirection(ScrollDirection).
  Parameters:
  
  content - the content of this scroller
  
  See Also:
  
  setContent(Component)
- Scroller
  
  public Scroller(Component content, Scroller.ScrollDirection scrollDirection)
  
  Convenience constructor to create a scroller with the given content and scroll direction.
  
  Parameters:
  
  content - the content of this scroller
  
  scrollDirection - scroll direction that the scroller will have
- Scroller
  
  public Scroller(Scroller.ScrollDirection scrollDirection)
  
  Convenience constructor to create an empty scroller with the given scroll direction. Content can be set with setContent(Component)
  
  Parameters:
  
  scrollDirection - scroll direction that the scroller will have
Method Details
- setContent
  
  public void setContent(Component content)
  
  Sets the content of this scroller. The content must always be set, either with a constructor parameter or by calling this method.
  
  Parameters:
  
  content - a component to use as content
- getContent
  
  public Component getContent()
  
  Gets the content of this scroller.
  
  Returns:
  
  the component used as content
- setScrollDirection
  
  public void setScrollDirection(Scroller.ScrollDirection scrollDirection)
  
  Sets the scroll direction for this scroller. Defaults to Scroller.ScrollDirection.BOTH.
  
  Parameters:
  
  scrollDirection - Scroller.ScrollDirection.BOTH to enable both vertical and horizontal scrollbars. Scroller.ScrollDirection.HORIZONTAL to enable only horizontal scrollbars. Scroller.ScrollDirection.VERTICAL to enable only vertical scrollbars. Scroller.ScrollDirection.NONE to disable both vertical and horizontal scrollbars.
- getScrollDirection
  
  public Scroller.ScrollDirection getScrollDirection()
  
  Returns the scroll direction for this scroller.
  Returns:
  
  the scroll direction for this scroller.
  
  See Also:
  
  setScrollDirection(ScrollDirection)
- scrollToTop
  
  public void scrollToTop()
  
  Scrolls the scroller to the top.
- scrollToBottom
  
  public void scrollToBottom()
  
  Scrolls the scroller to the bottom.