Package org.zkoss.stateless.sul

Interface IBreadcrumb

All Superinterfaces:

IAnyGroup<IBreadcrumb>, IChildable<IBreadcrumb,IBreadcrumbitem>, IComponent<IBreadcrumb>, IHtmlBasedComponent<IBreadcrumb>, IXulElement<IBreadcrumb>

public interface IBreadcrumb
extends IXulElement<IBreadcrumb>, IChildable<IBreadcrumb,IBreadcrumbitem>, IAnyGroup<IBreadcrumb>

Immutable Breadcrumb component.

A breadcrumb navigation. Contains an ordered list of IBreadcrumbitem.

Since:

11.0.0

Author:

peaker

See Also:

• Breadcrumb

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IBreadcrumb.Builder	Builds instances of type IBreadcrumb.
static class	IBreadcrumb.Updater	Builds an updater of type IBreadcrumb for UiAgent.smartUpdate(Locator, SmartUpdater).

Field Summary

Fields

Modifier and Type	Field	Description
static final IBreadcrumb	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default int	getMaxItems()	Returns the maximum number of items to display before collapsing.
default String	getSeparator()	Returns the separator between items, or null when it was reset to the default.
default String	getWidgetClass()	Returns the client widget class.
static IBreadcrumb	of(Iterable<? extends IBreadcrumbitem> children)	Returns the instance with the given IBreadcrumbitem children.
static IBreadcrumb	of(IBreadcrumbitem... children)	Returns the instance with the given IBreadcrumbitem children.
static IBreadcrumb	ofId(String id)	Returns the instance with the given id.
IBreadcrumb	withMaxItems(int maxItems)	Returns a copy of this immutable component with the specified maxItems.
IBreadcrumb	withSeparator(String separator)	Returns a copy of this immutable component with the specified separator.

Methods inherited from interface org.zkoss.stateless.sul.IChildable

getChildren, withChildren, withChildren

Methods inherited from interface org.zkoss.stateless.sul.IComponent

getAction, getActions, getClientAttributes, getId, getMold, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent

getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withSkeleton, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

Field Details

DEFAULT

static final IBreadcrumb DEFAULT

Constant for default attributes of this immutable component.

Method Details

getWidgetClass

default String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Breadcrumb"

Specified by:

getWidgetClass in interface IComponent<IBreadcrumb>

getSeparator

@Nullable
default String getSeparator()

Returns the separator between items, or null when it was reset to the default.

Default: "/".

withSeparator

IBreadcrumb withSeparator(@Nullable
 String separator)

Returns a copy of this immutable component with the specified separator.

Sets the separator. Also accepts icon form: "icon:z-icon-chevron-right".

Parameters:

separator - the separator between items, or null to reset to the default, as Breadcrumb.setSeparator(String) does.

Default: "/".

Returns:

A modified copy of the this object

getMaxItems

default int getMaxItems()

Returns the maximum number of items to display before collapsing.

Default: 0 (no limit).

withMaxItems

IBreadcrumb withMaxItems(int maxItems)

Returns a copy of this immutable component with the specified maxItems.

Sets the maximum number of items to display before collapsing.

Use 0 to disable collapse (default). A non-zero value must be >= 2 — the collapse always keeps the first and last item, so maxItems = 1 cannot actually hide anything and is rejected.

Parameters:

maxItems - the maximum number of items to display before collapsing.

Default: 0.

Returns:

A modified copy of the this object

Throws:

org.zkoss.zk.ui.WrongValueException - if maxItems is negative or equal to 1.

of

static IBreadcrumb of(Iterable<? extends IBreadcrumbitem> children)

Returns the instance with the given IBreadcrumbitem children.

Parameters:

children - The children of IBreadcrumbitem

of

static IBreadcrumb of(IBreadcrumbitem... children)

Returns the instance with the given IBreadcrumbitem children.

Parameters:

children - The children of IBreadcrumbitem

ofId

static IBreadcrumb ofId(String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component