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, Serializable
@Tag(value="vaadin-scroller") @NpmPackage(value="@vaadin/vaadin-ordered-layout", version="1.4.0") @JsModule(value="@vaadin/vaadin-ordered-layout/vaadin-scroller.js") public class Scroller extends Component implements HasSize, HasStyleScroller is a component container which enables scrolling overflowing content. Scroll direction can be configured with
setScrollDirection(ScrollDirection)See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classScroller.ScrollDirectionEnum for the values of the ScrollDirection property.
-
Constructor Summary
Constructors Constructor and 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
All Methods Modifier and Type Method and Description ComponentgetContent()Gets the content of this scroller.
Scroller.ScrollDirectiongetScrollDirection()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, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.HasSize
getCssSize, 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.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
Constructor Detail
-
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
public Scroller(Component content)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
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 scrollerscrollDirection- 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 Detail
-
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.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
public Scroller.ScrollDirection getScrollDirection()Returns the scroll direction for this scroller.
Returns:
the scroll direction for this scroller.
See Also:
-
-