Module io.github.mmm.ui.api.breadcrumb

Package io.github.mmm.ui.api.widget.breadcrumb

Interface UiBreadCrumbBar

All Superinterfaces:

AttributeReadAttached, AttributeReadEnabled, AttributeReadId, AttributeReadValid, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteId, AttributeWriteReadOnly, AttributeWriteTooltip, AttributeWriteVisible, io.github.mmm.event.EventSource<UiEvent,UiEventListener>, UiNativeWidget, UiRegularWidget, UiWidget

public interface UiBreadCrumbBar
extends UiRegularWidget, UiNativeWidget

A UiBreadCrumbBar shows a bread crumb as a (horizontal) bar. The bread crumb displays the hierarchy leading to the current dialogue and allows the user to click on the parent entries (hyperlinks) to navigate up this hierarchy. Typically the last entry should be added via add(String) without any UiClickEventListener.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
UiBreadCrumbEntry	add(String text)
default UiBreadCrumbEntry	add(String text, UiPlace place, String id)
void	clear()	Clears the bread crumb bar by removing all entries.
UiBreadCrumbEntry	get(int index)
int	getSize()
void	pop()	Removes the last UiBreadCrumbEntry from this UiBreadCrumbBar.

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadAttached

isAttached

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId

getId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId

setId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip

getTooltip, setTooltip

Methods inherited from interface io.github.mmm.event.EventSource

addListener, addListener, addWeakListener, removeListener

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget

cast, dispose, getModificationTimestamp, getParent, getReadOnlyFixed, getStyles, isDisposed, isEnabled, isEnabled, isFocused, isModified, isReadOnly, isValid, isVisible, isVisible, reset, setEnabled, setEnabled, setFocused, setReadOnly, setReadOnlyFixed, setVisible, setVisible, validate, validate, validate, validateDown, validateUp

Method Detail

add

UiBreadCrumbEntry add(String text)

Parameters:

text - the label text of the new entry.

Returns:

the new UiBreadCrumbEntry.

add

default UiBreadCrumbEntry add(String text,
                              UiPlace place,
                              String id)

Parameters:

text - the label text of the new entry.

place - the UiPlace where to navigate to when the new bread crumb entry is clicked.

id - the ID of the new entry.

Returns:

the new UiBreadCrumbEntry.

get

UiBreadCrumbEntry get(int index)

Parameters:

index - the index of the requested entry. Should be in the range from 0 to getSize()-1.

Returns:

the UiBreadCrumbEntry at the given index or null if no such entry exists.

pop

void pop()

Removes the last UiBreadCrumbEntry from this UiBreadCrumbBar. So in other words this method will undo the last add operation.

getSize

int getSize()

Returns:

the current number of entries in this bread crumb bar.

clear

void clear()

Clears the bread crumb bar by removing all entries.