Package com.storedobject.vaadin

Class Breadcrumbs

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<ButtonLayout>

com.storedobject.vaadin.Breadcrumbs

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable

public class Breadcrumbs
extends com.vaadin.flow.component.Composite<ButtonLayout>

Breadcrumbs component. A ClickHandler may be used to make the Breadcrumbs.Breadcrumbs clickable. If the Breadcrumbs.Breadcrumbs are clickable, the ClickHandler's ClickHandler.clicked(Component) method will be invoked when it is clicked and the Breadcrumbs.Breadcrumbs up to the clicked one will be pruned.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Breadcrumbs.Breadcrumb	Component that represents a "breadcrumb".
static interface	Breadcrumbs.BreadcrumbRemovalListener	Listener interface for "breadcrumb removal listener".

Constructor Summary

Constructors

Constructor	Description
Breadcrumbs()	Constructor.
Breadcrumbs(ClickHandler clickHandler)	Constructor with a "Click Handler".

Method Summary

Modifier and Type	Method	Description
Breadcrumbs.Breadcrumb	add(String caption)	Create a new Breadcrumbs.Breadcrumb and add it to this.
Breadcrumbs.Breadcrumb	getChild(Breadcrumbs.Breadcrumb breadcrumb)	Get the child of the given breadcrumb.
Breadcrumbs.Breadcrumb	getHead()	Get the head breadcrumb.
Breadcrumbs.Breadcrumb	getParent(Breadcrumbs.Breadcrumb breadcrumb)	Get the parent of the given breadcrumb.
void	goTo(Breadcrumbs.Breadcrumb breadcrumb)	Jump to a given Breadcrumbs.Breadcrumb.
protected ButtonLayout	initContent()
void	remove()	Remove the Breadcrumbs.Breadcrumb from the tail end if one exists.
void	remove(Breadcrumbs.Breadcrumb breadcrumb)	Remove a given Breadcrumbs.Breadcrumb.
Stream<Breadcrumbs.Breadcrumb>	streamChildren()	Stream all child breadcrumbs.

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

Breadcrumbs

public Breadcrumbs()

Constructor.

Breadcrumbs

public Breadcrumbs(ClickHandler clickHandler)

Constructor with a "Click Handler".

Parameters:

clickHandler - Click handler

Method Details

initContent

protected ButtonLayout initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<ButtonLayout>

add

public Breadcrumbs.Breadcrumb add(String caption)

Create a new Breadcrumbs.Breadcrumb and add it to this.

Parameters:

caption - Caption text of the Breadcrumbs.Breadcrumb to be created

Returns:

The Breadcrumbs.Breadcrumb that is created and added.

remove

public void remove()

Remove the Breadcrumbs.Breadcrumb from the tail end if one exists.

remove

public void remove(Breadcrumbs.Breadcrumb breadcrumb)

Remove a given Breadcrumbs.Breadcrumb. All Breadcrumbs.Breadcrumb appearing after the given one will be removed.

Parameters:

breadcrumb - Breadcrumbs.Breadcrumb to be removed

goTo

public void goTo(Breadcrumbs.Breadcrumb breadcrumb)

Jump to a given Breadcrumbs.Breadcrumb. All Breadcrumbs.Breadcrumb appearing after the given one will be removed.

Parameters:

breadcrumb - Breadcrumbs.Breadcrumb to go to

getParent

public Breadcrumbs.Breadcrumb getParent(Breadcrumbs.Breadcrumb breadcrumb)

Get the parent of the given breadcrumb.

Parameters:

breadcrumb - Breadcrumb for which parent needs to be obtained.

Returns:

Parent or null if it is the first breadcrumb.

getChild

public Breadcrumbs.Breadcrumb getChild(Breadcrumbs.Breadcrumb breadcrumb)

Get the child of the given breadcrumb.

Parameters:

breadcrumb - Breadcrumb for which child needs to be obtained.

Returns:

Parent or null if it is the last breadcrumb.

getHead

public Breadcrumbs.Breadcrumb getHead()

Get the head breadcrumb.

Returns:

The breadcrumb at the head. Could be null.

streamChildren

public Stream<Breadcrumbs.Breadcrumb> streamChildren()

Stream all child breadcrumbs.

Returns:

Stream of child breadcrumbs.