We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.orderedlayout.
Class Scroller
java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.orderedlayout.Scroller
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, HasTheme, HasThemeVariant<ScrollerVariant>, Serializable
@Tag("vaadin-scroller")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.0.3") @NpmPackage(value="@vaadin/scroller",version="24.0.3")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/scroller/vaadin-scroller.js")
public class Scroller
extends Component
implements HasSize, HasStyle, HasThemeVariant<ScrollerVariant>
Scroller is a component container which enables scrolling overflowing
content.
Scroll direction can be configured with
setScrollDirection(ScrollDirection)
See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumEnum for the values of the ScrollDirection property.
-
Constructor Summary
ConstructorsConstructorDescriptionScroller()Constructs an empty scroller.
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 TypeMethodDescriptionGets the content of this scroller.
Returns the scroll direction for this scroller.
voidsetContent(Component content) Sets the content of this scroller.
voidsetScrollDirection(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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeNameMethods 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 toScroller.ScrollDirection.BOTHand can be set withsetScrollDirection(ScrollDirection). -
Scroller
Convenience constructor to create a scroller with the given content. Scroll direction defaults to
Scroller.ScrollDirection.BOTHand can be set withsetScrollDirection(ScrollDirection).Parameters:
content- the content of this scrollerSee Also:
-
Scroller
Convenience constructor to create a scroller with the given content and scroll direction.
Parameters:
content- the content of this scrollerscrollDirection- scroll direction that the scroller will have -
Scroller
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
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
Gets the content of this scroller.
Returns:
the component used as content
-
setScrollDirection
Sets the scroll direction for this scroller. Defaults to
Scroller.ScrollDirection.BOTH.Parameters:
scrollDirection-Scroller.ScrollDirection.BOTHto enable both vertical and horizontal scrollbars.Scroller.ScrollDirection.HORIZONTALto enable only horizontal scrollbars.Scroller.ScrollDirection.VERTICALto enable only vertical scrollbars.Scroller.ScrollDirection.NONEto disable both vertical and horizontal scrollbars. -
getScrollDirection
Returns the scroll direction for this scroller.
Returns:
the scroll direction for this scroller.
See Also:
-