org.dominokit.domino.ui.spin

Class VSpinSelect<T>

java.lang.Object

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

org.dominokit.domino.ui.spin.VSpinSelect<T>

Type Parameters:

T - the type of the object inside the spin

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,VSpinSelect<T>,VSpinSelect<T>>, HasChildren<VSpinSelect<T>>, HasSelectionHandler<VSpinSelect<T>,SpinItem<T>>, HasWavesElement, IsCollapsible<VSpinSelect<T>>, IsReadOnly<VSpinSelect<T>>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class VSpinSelect<T>
extends BaseDominoElement<elemental2.dom.HTMLDivElement,S>

A component provides vertical spin

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

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasSelectionHandler

HasSelectionHandler.SelectionHandler<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected DominoElement<elemental2.dom.HTMLDivElement>	contentPanel
protected DominoElement<elemental2.dom.HTMLDivElement>	element
protected List<SpinItem<T>>	items
protected DominoElement<elemental2.dom.HTMLDivElement>	main

Constructor Summary

Constructors

Constructor and Description
VSpinSelect()
VSpinSelect(BaseIcon<?> backIcon, BaseIcon<?> forwardIcon)

Method Summary

Modifier and Type	Method and Description
S	addSelectionHandler(HasSelectionHandler.SelectionHandler<SpinItem<T>> selectionHandler) Adds a Selection handler to the component
S	appendChild(SpinItem<T> spinItem) Adds a new item
static <T> VSpinSelect<T>	create() Creates new instance
static <T> VSpinSelect<T>	create(BaseIcon<?> backIcon, BaseIcon<?> forwardIcon) Creates new instance with back/forward icons
elemental2.dom.HTMLDivElement	element()
protected void	fixElementsWidth()
SpinItem<T>	getActiveItem()
DominoElement<elemental2.dom.HTMLDivElement>	getContentPanel()
List<SpinItem<T>>	getItems()
DominoElement<elemental2.dom.HTMLAnchorElement>	getNextAnchor()
DominoElement<elemental2.dom.HTMLAnchorElement>	getPrevAnchor()
protected String	getStyle()
S	gotoFirst() Move to the first item
S	gotoLast() Move to the last item
int	indexOf(SpinItem<T> item)
boolean	isFirstItem(SpinItem<T> item)
boolean	isLastItem(SpinItem<T> item)
int	itemsCount()
S	moveBack() Move back to the previous item
S	moveForward() Move to the next item
S	moveToIndex(int targetIndex) Move to item at a specific index
S	moveToItem(SpinItem<T> item) Move to a specific item
S	onNavigate(NavigationHandler navigationHandler) Adds a handler which will be called when navigating between items
S	removeSelectionHandler(HasSelectionHandler.SelectionHandler<SpinItem<T>> selectionHandler)
protected void	setTransformProperty(double offset)

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

Field Detail

element

protected DominoElement<elemental2.dom.HTMLDivElement> element

contentPanel

protected DominoElement<elemental2.dom.HTMLDivElement> contentPanel

main

protected DominoElement<elemental2.dom.HTMLDivElement> main

items

protected List<SpinItem<T>> items

Constructor Detail

VSpinSelect

public VSpinSelect()

VSpinSelect

public VSpinSelect(BaseIcon<?> backIcon,
                   BaseIcon<?> forwardIcon)

Method Detail

create

public static <T> VSpinSelect<T> create()

Creates new instance

Type Parameters:

T - the type of the object inside the spin

Returns:

new instance

create

public static <T> VSpinSelect<T> create(BaseIcon<?> backIcon,
                                        BaseIcon<?> forwardIcon)

Creates new instance with back/forward icons

Type Parameters:

T - the type of the object inside the spin

Parameters:

backIcon - the back BaseIcon

forwardIcon - the forward BaseIcon

Returns:

new instance

setTransformProperty

protected void setTransformProperty(double offset)

getStyle

protected String getStyle()

fixElementsWidth

protected void fixElementsWidth()

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,VSpinSelect<T>>

Returns:

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

moveForward

public S moveForward()

Move to the next item

Returns:

same instance

moveBack

public S moveBack()

Move back to the previous item

Returns:

same instance

moveToIndex

public S moveToIndex(int targetIndex)

Move to item at a specific index

Parameters:

targetIndex - the index of the item

Returns:

same instance

moveToItem

public S moveToItem(SpinItem<T> item)

Move to a specific item

Parameters:

item - the SpinItem

Returns:

same instance

appendChild

public S appendChild(SpinItem<T> spinItem)

Adds a new item

Parameters:

spinItem - A SpinItem to add

Returns:

same instance

getActiveItem

public SpinItem<T> getActiveItem()

Returns:

the current active item

addSelectionHandler

public S addSelectionHandler(HasSelectionHandler.SelectionHandler<SpinItem<T>> selectionHandler)

Adds a Selection handler to the component

Specified by:

addSelectionHandler in interface HasSelectionHandler<S extends org.dominokit.domino.ui.spin.SpinSelect<T,?>,SpinItem<T>>

Parameters:

selectionHandler - Selectable.SelectionHandler

Returns:

same implementing component instance

removeSelectionHandler

public S removeSelectionHandler(HasSelectionHandler.SelectionHandler<SpinItem<T>> selectionHandler)

Specified by:

removeSelectionHandler in interface HasSelectionHandler<S extends org.dominokit.domino.ui.spin.SpinSelect<T,?>,SpinItem<T>>

getItems

public List<SpinItem<T>> getItems()

Returns:

All the items

indexOf

public int indexOf(SpinItem<T> item)

Parameters:

item - the SpinItem

Returns:

the index of the item inside the spin

itemsCount

public int itemsCount()

Returns:

the total number of items inside the spin

isLastItem

public boolean isLastItem(SpinItem<T> item)

Parameters:

item - the SpinItem

Returns:

true if the item is the last item, false otherwise

isFirstItem

public boolean isFirstItem(SpinItem<T> item)

Parameters:

item - the SpinItem

Returns:

true if the item is the first item, false otherwise

gotoFirst

public S gotoFirst()

Move to the first item

Returns:

same instance

gotoLast

public S gotoLast()

Move to the last item

Returns:

same instance

onNavigate

public S onNavigate(NavigationHandler navigationHandler)

Adds a handler which will be called when navigating between items

Parameters:

navigationHandler - A NavigationHandler to add

Returns:

same instance

getPrevAnchor

public DominoElement<elemental2.dom.HTMLAnchorElement> getPrevAnchor()

Returns:

the previous element

getNextAnchor

public DominoElement<elemental2.dom.HTMLAnchorElement> getNextAnchor()

Returns:

the next element

getContentPanel

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

Returns:

the content panel