Package com.flowingcode.vaadin.addons.carousel

Class Carousel

java.lang.Object

com.vaadin.flow.component.Component

com.flowingcode.vaadin.addons.carousel.Carousel

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasSize, HasTheme, Serializable

@Tag("fc-l2t-paper-slider")
@NpmPackage(value="@polymer/iron-a11y-keys-behavior",
            version="3.0.1")
@JsModule("./paper-slider/fc-l2t-paper-slider.js")
public class Carousel
extends Component
implements HasSize, HasTheme

A component that displays a slideshow of slides. By default the slides will be displayed with navigation buttons, autoplay and swipe enabled. You can configure the slideshow by adding custom parameters, such as duration of transition, start position, maximum height and disabling swipe.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Carousel.SlideChangeEvent

Constructor Summary

Constructors

Constructor	Description
Carousel(Slide... paperSlides)

Method Summary

Modifier and Type	Method	Description
Registration	addChangeListener(ComponentEventListener<Carousel.SlideChangeEvent> listener)
String	getHeight()
int	getSlideDuration()
Slide[]	getSlides()
int	getStartPosition()
boolean	isAutoProgress()
boolean	isDisableSwipe()
boolean	isHideNavigation()
void	moveNext()	Move to the next slide
void	movePos(int slide)	Move to a specific slide
void	movePrev()	Move to the previous slide
void	setAutoProgress(boolean autoProgress)
void	setDisableSwipe(boolean disableSwipe)
void	setHeight(String height)
void	setHideNavigation(boolean hideNavigation)
void	setSlideDuration(int slideDuration)
void	setSlides(Slide[] slides)
void	setStartPosition(int startPosition)
Carousel	withAutoProgress()
Carousel	withoutNavigation()
Carousel	withoutSwipe()
Carousel	withSlideDuration(int slideDuration)
Carousel	withStartPosition(int startPosition)

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.AttachNotifier

addAttachListener

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

addDetachListener

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

getElement

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

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

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

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

Constructor Details

Carousel

public Carousel(Slide... paperSlides)

Method Details

getSlides

public Slide[] getSlides()

setSlides

public void setSlides(Slide[] slides)

isAutoProgress

public boolean isAutoProgress()

setAutoProgress

public void setAutoProgress(boolean autoProgress)

getSlideDuration

public int getSlideDuration()

setSlideDuration

public void setSlideDuration(int slideDuration)

getStartPosition

public int getStartPosition()

setStartPosition

public void setStartPosition(int startPosition)

isDisableSwipe

public boolean isDisableSwipe()

setDisableSwipe

public void setDisableSwipe(boolean disableSwipe)

isHideNavigation

public boolean isHideNavigation()

setHideNavigation

public void setHideNavigation(boolean hideNavigation)

withAutoProgress

public Carousel withAutoProgress()

withoutSwipe

public Carousel withoutSwipe()

withoutNavigation

public Carousel withoutNavigation()

withSlideDuration

public Carousel withSlideDuration(int slideDuration)

withStartPosition

public Carousel withStartPosition(int startPosition)

setHeight

public void setHeight(String height)

Specified by:

setHeight in interface HasSize

getHeight

public String getHeight()

Specified by:

getHeight in interface HasSize

moveNext

public void moveNext()

Move to the next slide

movePrev

public void movePrev()

Move to the previous slide

movePos

public void movePos(int slide)

Move to a specific slide

Parameters:

slide -

addChangeListener

public Registration addChangeListener(ComponentEventListener<Carousel.SlideChangeEvent> listener)