Package org.zkoss.stateless.sul

Interface IBreadcrumbitem

All Superinterfaces:

IChildrenOfInputgroup<IBreadcrumbitem>, IComponent<IBreadcrumbitem>, IDisable<IBreadcrumbitem>, IHtmlBasedComponent<IBreadcrumbitem>, ILabelElement<IBreadcrumbitem>, ILabelImageElement<IBreadcrumbitem>, IXulElement<IBreadcrumbitem>

public interface IBreadcrumbitem
extends ILabelImageElement<IBreadcrumbitem>, IDisable<IBreadcrumbitem>

Immutable Breadcrumbitem component.

A single entry in an IBreadcrumb.

Since:

11.0.0

Author:

peaker

See Also:

Breadcrumbitem

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getHref()	Returns the navigation target URL.
default java.lang.String	getTarget()	Returns the browsing context target (e.g., "_blank").
default java.lang.String	getWidgetClass()	Returns the client widget class.
static IBreadcrumbitem	of(java.lang.String label)	Returns the instance with the given label.
static IBreadcrumbitem	of(java.lang.String label, java.lang.String href)	Returns the instance with the given label and href.
static IBreadcrumbitem	ofId(java.lang.String id)	Returns the instance with the given id.
IBreadcrumbitem	withHref(java.lang.String href)	Returns a copy of this immutable component with the specified href.
IBreadcrumbitem	withTarget(java.lang.String target)	Returns a copy of this immutable component with the specified target.

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.IDisable

isDisabled, withDisabled

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.ILabelElement

getLabel, withLabel

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

getHoverImage, getIconSclass, getIconSclasses, getIconTooltip, getIconTooltips, getImage, isPreloadImage, withHoverImage, withIconSclass, withIconSclasses, withIconTooltip, withIconTooltips, withImage, withPreloadImage

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

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

Field Detail

DEFAULT

static final IBreadcrumbitem DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Breadcrumbitem"

Specified by:

getWidgetClass in interface IComponent<IBreadcrumbitem>

getHref

@Nullable
default java.lang.String getHref()

Returns the navigation target URL.

Default: null. When null, the item renders as plain text (typically the last item).

withHref

IBreadcrumbitem withHref(@Nullable
                         java.lang.String href)

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

Sets the navigation target URL.

Note: UiAgent.smartUpdate(Locator, SmartUpdater) is not supported for this property — IBreadcrumbitem.Updater ships the raw attribute while the initial render ships the Execution#encodeURL form. Push a whole component with UiAgent.replaceWith(Locator, IComponent) instead.

Parameters:

href - the URL the item links to; when null the item renders as plain text.

Default: null.

Returns:

A modified copy of the this object

Throws:

org.zkoss.zk.ui.WrongValueException - if href uses an unsafe scheme (javascript:, vbscript:, blob:, filesystem:, or a non-image data: URI).

getTarget

@Nullable
default java.lang.String getTarget()

Returns the browsing context target (e.g., "_blank").

Default: null.

withTarget

IBreadcrumbitem withTarget(@Nullable
                           java.lang.String target)

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

Sets the browsing context target (e.g., "_blank").

Parameters:

target - the target browsing context.

Default: null.

Returns:

A modified copy of the this object

of

static IBreadcrumbitem of(java.lang.String label)

Returns the instance with the given label.

Parameters:

label - The label of the breadcrumb item

of

static IBreadcrumbitem of(java.lang.String label,
                          java.lang.String href)

Returns the instance with the given label and href.

Parameters:

label - The label of the breadcrumb item

href - The URL the breadcrumb item links to

ofId

static IBreadcrumbitem ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component