org.dominokit.domino.ui.breadcrumbs

Class Breadcrumb

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLOListElement,Breadcrumb>

org.dominokit.domino.ui.breadcrumbs.Breadcrumb

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLOListElement,Breadcrumb,Breadcrumb>, HasBackground<Breadcrumb>, HasChildren<Breadcrumb>, HasWavesElement, IsCollapsible<Breadcrumb>, IsReadOnly<Breadcrumb>, org.jboss.elemento.IsElement<elemental2.dom.HTMLOListElement>

public class Breadcrumb
extends BaseDominoElement<elemental2.dom.HTMLOListElement,Breadcrumb>
implements HasBackground<Breadcrumb>

Provides current location in a navigational hierarchy.

This component displays locations with the ability to navigate between them and highlighting the current one, each location can have text and icon with a click listener that will be called when user clicks on it.

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

For example:

     Breadcrumb.create()
               .appendChild(" Home ", (evt) -> {//do something when clicked})
               .appendChild(" Library ", (evt) -> {//do something when clicked})
 

See Also:

BaseDominoElement, HasBackground, BreadcrumbItem

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
Breadcrumb()

Method Summary

Modifier and Type	Method and Description
Breadcrumb	alignCenter() Positions the breadcrumb to the center of its parent
Breadcrumb	alignRight() Positions the breadcrumb to the right of its parent
Breadcrumb	appendChild(BaseIcon<?> icon, String text, elemental2.dom.EventListener onClick) Adds new location with text, icon and onClick listener
Breadcrumb	appendChild(BreadcrumbItem... items) Adds new location by providing BreadcrumbItem
Breadcrumb	appendChild(BreadcrumbItem item) Adds new location by providing BreadcrumbItem
Breadcrumb	appendChild(String text, elemental2.dom.EventListener onClick) Adds new location with text and onClick listener
static Breadcrumb	create() Creates new empty breadcrumb
elemental2.dom.HTMLOListElement	element()
BreadcrumbItem	getActiveItem()
List<BreadcrumbItem>	getItems()
boolean	isAllowNavigation()
Breadcrumb	removeAll() Removes all locations from the breadcrumb
Breadcrumb	setAllowNavigation(boolean allowNavigation) Sets if the breadcrumb supports navigation between its locations
Breadcrumb	setBackground(Color background)
Breadcrumb	setColor(Color color) Sets the color of the breadcrumb
Breadcrumb	setRemoveActiveTailItem(boolean removeTail) If true, then selecting location will remove the tailing ones.

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, 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

Breadcrumb

public Breadcrumb()

Method Detail

create

public static Breadcrumb create()

Creates new empty breadcrumb

Returns:

new breadcrumb instance

appendChild

public Breadcrumb appendChild(String text,
                              elemental2.dom.EventListener onClick)

Adds new location with text and onClick listener

Parameters:

text - the label of the location

onClick - EventListener that will be called when the location is clicked

Returns:

same instance

appendChild

public Breadcrumb appendChild(BaseIcon<?> icon,
                              String text,
                              elemental2.dom.EventListener onClick)

Adds new location with text, icon and onClick listener

Parameters:

icon - the BaseIcon of the location

text - the label of the location

onClick - EventListener that will be called when the location is clicked

Returns:

same instance

appendChild

public Breadcrumb appendChild(BreadcrumbItem... items)

Adds new location by providing BreadcrumbItem

Parameters:

items - the BreadcrumbItem location to be added

Returns:

same instance

appendChild

public Breadcrumb appendChild(BreadcrumbItem item)

Adds new location by providing BreadcrumbItem

Parameters:

item - the BreadcrumbItem location to be added

Returns:

same instance

setAllowNavigation

public Breadcrumb setAllowNavigation(boolean allowNavigation)

Sets if the breadcrumb supports navigation between its locations

Parameters:

allowNavigation - true to allow navigation, false otherwise

Returns:

same instance

isAllowNavigation

public boolean isAllowNavigation()

Returns:

true if the breadcrumb supports navigation, false otherwise

setRemoveActiveTailItem

public Breadcrumb setRemoveActiveTailItem(boolean removeTail)

If true, then selecting location will remove the tailing ones.

For example:

• Given removeTail is true and having 4 locations as follows:

  A -> B -> C -> D

  when selecting location B, then the new locations will be as follows:

  A -> B

• Given removeTail is false and having 4 locations as follows:

  A -> B -> C -> D

  when selecting location B, then the new locations will be as follows:

  A -> B -> C -> D

Parameters:

removeTail - true for activating remove tail, false otherwise

Returns:

same instance

setColor

public Breadcrumb setColor(Color color)

Sets the color of the breadcrumb

Parameters:

color - the new Color

Returns:

same instance

alignCenter

public Breadcrumb alignCenter()

Positions the breadcrumb to the center of its parent

Specified by:

alignCenter in interface DominoStyle<elemental2.dom.HTMLOListElement,Breadcrumb,Breadcrumb>

Overrides:

alignCenter in class BaseDominoElement<elemental2.dom.HTMLOListElement,Breadcrumb>

Returns:

same instance

alignRight

public Breadcrumb alignRight()

Positions the breadcrumb to the right of its parent

Specified by:

alignRight in interface DominoStyle<elemental2.dom.HTMLOListElement,Breadcrumb,Breadcrumb>

Overrides:

alignRight in class BaseDominoElement<elemental2.dom.HTMLOListElement,Breadcrumb>

Returns:

same instance

removeAll

public Breadcrumb removeAll()

Removes all locations from the breadcrumb

Returns:

same instance

element

public elemental2.dom.HTMLOListElement element()

Specified by:

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

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLOListElement,Breadcrumb>

Returns:

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

setBackground

public Breadcrumb setBackground(Color background)

Specified by:

setBackground in interface HasBackground<Breadcrumb>

Parameters:

background - Color

Returns:

same implementing component

getActiveItem

public BreadcrumbItem getActiveItem()

Returns:

The active BreadcrumbItem location

getItems

public List<BreadcrumbItem> getItems()

Returns:

All BreadcrumbItem locations