org.dominokit.domino.ui.carousel

Class Carousel

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,Carousel>

org.dominokit.domino.ui.carousel.Carousel

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,Carousel,Carousel>, HasChildren<Carousel>, HasWavesElement, IsCollapsible<Carousel>, IsReadOnly<Carousel>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class Carousel
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Carousel>

A slideshow component for cycling through elements.

The component provides APIs for going through all the elements by next/previous indicators. Also, it provides automatic sliding with configurable duration.

Customize the component can be done by overwriting classes provided by CarouselStyles

For example:

     Carousel.create()
             .appendChild(
                 Slide.create(
                     GWT.getModuleBaseURL()
                         + "/images/image-gallery/11.jpg"))
             .appendChild(
                 Slide.create(
                     GWT.getModuleBaseURL()
                         + "/images/image-gallery/12.jpg"))
             .appendChild(
                 Slide.create(
                     GWT.getModuleBaseURL()
                         + "/images/image-gallery/19.jpg"))
             .appendChild(
                 Slide.create(
                     GWT.getModuleBaseURL() + "/images/image-gallery/9.jpg"))
             .appendChild(
                 Slide.create(
                     GWT.getModuleBaseURL()
                         + "/images/image-gallery/6.jpg")))
 

See Also:

BaseDominoElement, CarouselStyles

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Constructor Summary

Constructors

Constructor and Description
Carousel()

Method Summary

Modifier and Type	Method and Description
Carousel	appendChild(Slide slide) Adds new Slide, event listeners will be added to the slide for removing the motion styles
static Carousel	create() Creates new carousel
elemental2.dom.HTMLDivElement	element()
Slide	getActiveSlide()
DominoElement<elemental2.dom.HTMLOListElement>	getIndicatorsElement()
List<Slide>	getSlides()
DominoElement<elemental2.dom.HTMLDivElement>	getSlidesElement()
Carousel	startAutoSlide(int slideDuration) Slides through items every slideDuration
Carousel	stopAutoSlide() Stops the automatic sliding

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

Carousel

public Carousel()

Method Detail

create

public static Carousel create()

Creates new carousel

Returns:

new instance

appendChild

public Carousel appendChild(Slide slide)

Adds new Slide, event listeners will be added to the slide for removing the motion styles

Parameters:

slide - a Slide to be added

Returns:

same instance

startAutoSlide

public Carousel startAutoSlide(int slideDuration)

Slides through items every slideDuration

Parameters:

slideDuration - the time between slide between each element

Returns:

same instance

stopAutoSlide

public Carousel stopAutoSlide()

Stops the automatic sliding

Returns:

same instance

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,Carousel>

Returns:

the HTML element of type E which is the root element of the component

getIndicatorsElement

public DominoElement<elemental2.dom.HTMLOListElement> getIndicatorsElement()

Returns:

the indicator element

getSlidesElement

public DominoElement<elemental2.dom.HTMLDivElement> getSlidesElement()

Returns:

the slides element which has all the slides

getSlides

public List<Slide> getSlides()

Returns:

All the added slides

getActiveSlide

public Slide getActiveSlide()

Returns:

the currently active slide