org.dominokit.domino.ui.breadcrumbs

Class BreadcrumbItem

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLLIElement,BreadcrumbItem>

org.dominokit.domino.ui.breadcrumbs.BreadcrumbItem

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLLIElement,BreadcrumbItem,BreadcrumbItem>, HasChildren<BreadcrumbItem>, HasClickableElement, HasWavesElement, IsCollapsible<BreadcrumbItem>, IsReadOnly<BreadcrumbItem>, org.jboss.elemento.IsElement<elemental2.dom.HTMLLIElement>

public class BreadcrumbItem
extends BaseDominoElement<elemental2.dom.HTMLLIElement,BreadcrumbItem>
implements HasClickableElement

A component for Breadcrumb location.

This component provides basic styles of a location and functionalities that allows switching between location statuses

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

For example:

     Breadcrumb.create()
               .appendChild(BreadcrumbItem.create(" Home "))
 

See Also:

Breadcrumb, BaseDominoElement, HasClickableElement

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

Method Summary

Modifier and Type	Method and Description
BreadcrumbItem	activate() Sets item as active, customizing the active style can be done by overwriting BreadcrumbStyles.ACTIVE CSS class
static BreadcrumbItem	create(BaseIcon<?> icon, String text) Creates item with text content and icon
static BreadcrumbItem	create(String text) Creates location with text content
BreadcrumbItem	deActivate() Sets item as inactive
elemental2.dom.HTMLLIElement	element()
elemental2.dom.HTMLAnchorElement	getClickableElement() by default this return the same component root element
BaseIcon<?>	getIcon()
elemental2.dom.Text	getTextElement()
boolean	isActive()
BreadcrumbItem	setActive(boolean active) If true, sets the status to active, otherwise sets the status to inactive

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

Method Detail

create

public static BreadcrumbItem create(String text)

Creates location with text content

Parameters:

text - the content of the item

Returns:

new instance

create

public static BreadcrumbItem create(BaseIcon<?> icon,
                                    String text)

Creates item with text content and icon

Parameters:

icon - the BaseIcon of the item

text - the content of the item

Returns:

new instance

activate

public BreadcrumbItem activate()

Sets item as active, customizing the active style can be done by overwriting BreadcrumbStyles.ACTIVE CSS class

Returns:

same instance

deActivate

public BreadcrumbItem deActivate()

Sets item as inactive

Returns:

same instance

setActive

public BreadcrumbItem setActive(boolean active)

If true, sets the status to active, otherwise sets the status to inactive

Parameters:

active - the boolean to set the status

Returns:

same instance

element

public elemental2.dom.HTMLLIElement element()

Specified by:

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

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLLIElement,BreadcrumbItem>

Returns:

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

getClickableElement

public elemental2.dom.HTMLAnchorElement getClickableElement()

by default this return the same component root element

Specified by:

getClickableElement in interface HasClickableElement

Overrides:

getClickableElement in class BaseDominoElement<elemental2.dom.HTMLLIElement,BreadcrumbItem>

Returns:

the HTMLElement that should receive and click listeners

getTextElement

public elemental2.dom.Text getTextElement()

Returns:

the Text content

getIcon

public BaseIcon<?> getIcon()

Returns:

the BaseIcon

isActive

public boolean isActive()

Returns:

true if the item is active, false otherwise