Package org.zkoss.stateless.sul

Interface ICarouselitem<I extends IAnyGroup>

All Superinterfaces:

IChildable<ICarouselitem<I>,I>, IChildrenOfInputgroup<ICarouselitem<I>>, IComponent<ICarouselitem<I>>, IHtmlBasedComponent<ICarouselitem<I>>, ILabelElement<ICarouselitem<I>>, ILabelImageElement<ICarouselitem<I>>, IXulElement<ICarouselitem<I>>

public interface ICarouselitem<I extends IAnyGroup>
extends ILabelImageElement<ICarouselitem<I>>, IChildable<ICarouselitem<I>,I>

Immutable Carouselitem component.

A single slide inside an ICarousel. Besides its own label and image, it may hold any kind of children, which are placed right after them.

Since:

11.0.0

Author:

peaker

See Also:

Carouselitem

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ICarouselitem.Builder<I extends IAnyGroup>	Builds instances of type ICarouselitem.
static class	ICarouselitem.Updater	Builds an updater of type ICarouselitem for UiAgent.smartUpdate(Locator, SmartUpdater).

Field Summary

Fields

Modifier and Type	Field	Description
static ICarouselitem<IAnyGroup>	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getWidgetClass()	Returns the client widget class.
static <I extends IAnyGroup> ICarouselitem<I>	of(I... children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICarouselitem<I>	of(java.lang.Iterable<? extends I> children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICarouselitem<I>	of(java.lang.String label)	Returns the instance with the given label.
static <I extends IAnyGroup> ICarouselitem<I>	of(java.lang.String label, java.lang.String image)	Returns the instance with the given label and image.
static <I extends IAnyGroup> ICarouselitem<I>	ofId(java.lang.String id)	Returns the instance with the given id.
static <I extends IAnyGroup> ICarouselitem<I>	ofImage(java.lang.String image)	Returns the instance with the given image.

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.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 ICarouselitem<IAnyGroup> 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.Carouselitem"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

of

static <I extends IAnyGroup> ICarouselitem<I> of(java.lang.String label)

Returns the instance with the given label.

Parameters:

label - The label of the slide

of

static <I extends IAnyGroup> ICarouselitem<I> of(java.lang.String label,
                                                 java.lang.String image)

Returns the instance with the given label and image.

Parameters:

label - The label of the slide

image - The image of the slide

of

static <I extends IAnyGroup> ICarouselitem<I> of(java.lang.Iterable<? extends I> children)

Returns the instance with the given any group children.

Parameters:

children - The children belong to any group

See Also:

IAnyGroup

of

static <I extends IAnyGroup> ICarouselitem<I> of(I... children)

Returns the instance with the given any group children.

Parameters:

children - The children belong to any group

See Also:

IAnyGroup

ofImage

static <I extends IAnyGroup> ICarouselitem<I> ofImage(java.lang.String image)

Returns the instance with the given image.

Parameters:

image - The image of the slide

ofId

static <I extends IAnyGroup> ICarouselitem<I> ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component