org.dominokit.domino.ui.carousel

Class Slide

java.lang.Object

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

org.dominokit.domino.ui.carousel.Slide

All Implemented Interfaces:

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

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

A component for an element for Carousel

Images can be added to the component with the ability to add label and description

See Also:

BaseDominoElement, Carousel

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

Field Summary

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

element

Constructor Summary

Constructors

Constructor and Description
Slide(elemental2.dom.HTMLImageElement image)
Slide(elemental2.dom.HTMLImageElement image, String label, String description)
Slide(elemental2.dom.HTMLPictureElement pictureElement)
Slide(elemental2.dom.HTMLPictureElement pictureElement, String label, String description)
Slide(String imageSrc)
Slide(String imageSrc, String label, String description)

Method Summary

Modifier and Type	Method and Description
Slide	activate() Activates this slide.
static Slide	create(elemental2.dom.HTMLImageElement image) Creates new slide with HTMLImageElement
static Slide	create(elemental2.dom.HTMLImageElement image, String label, String description) Creates new slide with HTMLImageElement, label and description
static Slide	create(elemental2.dom.HTMLPictureElement pictureElement) Creates new slide with HTMLPictureElement
static Slide	create(elemental2.dom.HTMLPictureElement pictureElement, String label, String description) Creates new slide with HTMLPictureElement, label and description
static Slide	create(String imageSrc) Creates new slide with image source
static Slide	create(String imageSrc, String label, String description) Creates new slide with image source, label and description
elemental2.dom.HTMLDivElement	element()
DominoElement<elemental2.dom.HTMLDivElement>	getCaptionElement()
DominoElement<elemental2.dom.HTMLElement>	getImageElement()
DominoElement<elemental2.dom.HTMLLIElement>	getIndicatorElement()
DominoElement<elemental2.dom.HTMLParagraphElement>	getSlideDescriptionElement()
DominoElement<elemental2.dom.HTMLHeadingElement>	getSlideLabelElement()
boolean	hasActiveStyle() Checks if this slide has CarouselStyles.ACTIVE style
boolean	isActive()
void	setActiveFlag(boolean active) Sets the slide to active without changing the styles

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

Slide

public Slide(String imageSrc)

Slide

public Slide(elemental2.dom.HTMLImageElement image)

Slide

public Slide(elemental2.dom.HTMLPictureElement pictureElement)

Slide

public Slide(String imageSrc,
             String label,
             String description)

Slide

public Slide(elemental2.dom.HTMLImageElement image,
             String label,
             String description)

Slide

public Slide(elemental2.dom.HTMLPictureElement pictureElement,
             String label,
             String description)

Method Detail

create

public static Slide create(String imageSrc)

Creates new slide with image source

Parameters:

imageSrc - the url for the image

Returns:

new instance

create

public static Slide create(String imageSrc,
                           String label,
                           String description)

Creates new slide with image source, label and description

Parameters:

imageSrc - the url for the image

label - the image label

description - the image description

Returns:

new instance

create

public static Slide create(elemental2.dom.HTMLImageElement image)

Creates new slide with HTMLImageElement

Parameters:

image - the HTMLImageElement

Returns:

new instance

create

public static Slide create(elemental2.dom.HTMLPictureElement pictureElement)

Creates new slide with HTMLPictureElement

Parameters:

pictureElement - the HTMLPictureElement

Returns:

new instance

create

public static Slide create(elemental2.dom.HTMLPictureElement pictureElement,
                           String label,
                           String description)

Creates new slide with HTMLPictureElement, label and description

Parameters:

pictureElement - the HTMLPictureElement

label - the image label

description - the image description

Returns:

new instance

create

public static Slide create(elemental2.dom.HTMLImageElement image,
                           String label,
                           String description)

Creates new slide with HTMLImageElement, label and description

Parameters:

image - the HTMLImageElement

label - the image label

description - the image description

Returns:

new instance

getIndicatorElement

public DominoElement<elemental2.dom.HTMLLIElement> getIndicatorElement()

Returns:

The indicator element

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,Slide>

Returns:

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

activate

public Slide activate()

Activates this slide. This will add CarouselStyles.ACTIVE style to the slide

Returns:

same instance

setActiveFlag

public void setActiveFlag(boolean active)

Sets the slide to active without changing the styles

Parameters:

active - a boolean that indicates this slide is active

isActive

public boolean isActive()

Returns:

True if this slide is active, false otherwise

hasActiveStyle

public boolean hasActiveStyle()

Checks if this slide has CarouselStyles.ACTIVE style

Returns:

true if the slide has active style, false otherwise

getSlideLabelElement

public DominoElement<elemental2.dom.HTMLHeadingElement> getSlideLabelElement()

Returns:

The slide label element

getSlideDescriptionElement

public DominoElement<elemental2.dom.HTMLParagraphElement> getSlideDescriptionElement()

Returns:

The slide description element

getCaptionElement

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

Returns:

The slide caption element

getImageElement

public DominoElement<elemental2.dom.HTMLElement> getImageElement()

Returns:

The image element