Domino UI UI components library
Domino Brix MVP framework for DominoKit apps
Domino Jackson JSON Mapping library
Domino Rest REST Client generation library
Domino History URL Manipulation library

Carousel

A slideshow component for cycling through elements.

The component provides the means needed to go through a set of elements using next/previous buttons or automatically switch between them with configurable duration.

Slide

A slide component used with Carousel

The component provide the means to create an image slide with different types of image elements or components

Anatomy

Carousel active slide.
Previous slide manual navigation arrow.
Next slide manual navigation arrow.
Slide title, Optional.
Slide description, Optional.
Slide selection navigation and marker.

Examples

Basic carousel A carousel with manual navigation between the slides.

Auto slide carousel A carousel that auto switch slides periodically.

API Docs: Carousel

Browse full javadocs

Constructors

public void Carousel()

Creates and empty Carousel

Static methods

public static Carousel create()

Factory method to create an empty Carousel

Returns:

new instance

Public methods

public Carousel next()

Programmatically move to the next slide and reset the slide timer

Returns:

Same Carousel instance

public Carousel previous()

Programmatically move to the previous slide and reset the slide timer

Returns:

Same Carousel instance

public Carousel gotToSlide(Slide slide, SlideDirection direction)

Programmatically move to the specified slide sliding to the provided direction and reset the slide timer

Returns:

Same Carousel instance

public Carousel gotToSlide(int index, SlideDirection direction)

Programmatically move to the slide of the specified index sliding to the provided direction and reset the slide timer

Returns:

Same Carousel instance

public Carousel appendChild(Slide slide)

Adds new Slide to this Carousel

slide

The Slide to be added

Returns:

same carousel instance

public Carousel startAutoSlide(int slideDuration)

Slides through items every slideDuration

slideDuration

The duration to wait before moving the next slide

Returns:

same instance

public Carousel stopAutoSlide()

Stops the automatic sliding

Returns:

same instance

public OListElement getIndicatorsElement()

Returns:

The OListElement holding the slides indicators

public DivElement getSlidesElement()

Returns:

a DivElement that holds all the slides elements

public Carousel withSlidesElement(ChildHandler<Carousel, DivElement> handler)

Use to apply customizations to the element containing all the slides without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public Carousel withIndicatorsElement(ChildHandler<Carousel, OListElement> handler)

Use to apply customizations to the element holding the slides indicators without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public Carousel withPreviousElement(ChildHandler<Carousel, AnchorElement> handler)

Use to apply customizations to the previous slide button without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public Carousel withNextElement(ChildHandler<Carousel, AnchorElement> handler)

Use to apply customizations to the next slide button without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public Carousel withPreviousIcon(ChildHandler<Carousel, MdiIcon> handler)

Use to apply customizations to the previous slide icon without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public Carousel withNextIcon(ChildHandler<Carousel, MdiIcon> handler)

Use to apply customizations to the next slide icon without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public List<Slide> getSlides()

Returns:

a List of all slides in this carousel

public Slide getActiveSlide()

Returns:

The current active Slide component

API Docs: Slide

Browse full javadocs

Constructors

public void Slide(String imageSrc)

Creates an image slide from the provided image url

imageSrc

The string image source that will be used as the value for the img tag src attribute.

public void Slide(HTMLImageElement image)

Creates an image slide from the provided image element

image

The HTMLImageElement element to be used for the slide

public void Slide(HTMLPictureElement pictureElement)

Creates an image slide from the provided picture element

pictureElement

The HTMLPictureElement element to be used for the slide.

public void Slide(ImageElement image)

Creates an image slide from the provided image component

image

The ImageElement element to be used for the slide.

public void Slide(PictureElement pictureElement)

Creates an image slide from the provided picture component

pictureElement

The PictureElement element to be used for the slide.

Static methods

public static Slide create(String imageSrc)

Factory method to create an image slide from the provided image url

imageSrc

The string image source that will be used as the value for the img tag src attribute.

Returns:

new instance

public static Slide create(HTMLImageElement image)

Factory method to create an image slide from the provided image element

image

The HTMLImageElement element to be used for the slide

Returns:

new instance

public static Slide create(HTMLPictureElement pictureElement)

Factory method to create an image slide from the provided picture element

pictureElement

The HTMLPictureElement element to be used for the slide.

Returns:

new instance

public static Slide create(ImageElement image)

Factory method to create an image slide from the provided image component

image

The ImageElement element to be used for the slide.

Returns:

new instance

public static Slide create(PictureElement pictureElement)

Factory method to create an image slide from the provided picture component

pictureElement

The PictureElement element to be used for the slide.

Returns:

new instance

public static Slide create(Element element)

Factory method to create a slide from any html element.

element

The HTMLElement element to be used for the slide.

Returns:

new instance

public static Slide create(IsElement<? extends Element> element)

Factory method to create a slide from any html element.

element

The IsElement element to be used for the slide.

Returns:

new instance

Public methods

public Slide activate()

Activates this slide. This will add dui_active style to the slide This method is a shortcut for setActive(true)

Returns:

same slide instance

public void setActive(boolean active)

Change the style active state

active

a boolean, true to make the slide active, false make the slide inactive.

public boolean isActive()

Use to check if the slide is currently active or not.

Returns:

a boolean, true if the slide is active, false if the slide is not active.

public DominoElement<HTMLLIElement> getIndicatorElement()

Returns:

This slide indicator element attached to the carousel slides indicators.

public Slide setLabel(String text)

Sets the slide title

text

the slide title text.

Returns:

same slide instance

public Slide setDescription(String text)

sets the slide description text

text

slide description text

Returns:

same slide instance

public HeadingElement getSlideLabelElement()

Returns:

The HeadingElement of the slide title.

public Slide withSlideLabelElement(ChildHandler<Slide, HeadingElement> handler)

Use to apply customizations to the slide title element without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public ParagraphElement getSlideDescriptionElement()

Returns:

The ParagraphElement of the slide description.

public Slide withSlideDescriptionElement(ChildHandler<Slide, ParagraphElement> handler)

Use to apply customizations to the slide description element without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public Slide withSlideCaptionElement(ChildHandler<Slide, DivElement> handler)

Use to apply customizations to the slide caption element which holds the title and description without breaking the fluent API chain.

handler

The ChildHandler applying the customizations

Returns:

same carousel instance

public DivElement getCaptionElement()

Returns:

The DivElement that holds the title and description elements

public DominoElement<Element> getWrappedElement()

Returns:

The element wrapped by this slide.

We are a group of passionate people who love what we do

Donate & Support Us