Package org.zkoss.stateless.sul

Interface ICaption<I extends IAnyGroup>

All Superinterfaces:

IAnyGroup<ICaption<I>>, IChildable<ICaption<I>,I>, IChildrenOfInputgroup<ICaption<I>>, IChildrenOfPanel<ICaption<I>>, IComponent<ICaption<I>>, IHtmlBasedComponent<ICaption<I>>, ILabelElement<ICaption<I>>, ILabelImageElement<ICaption<I>>, IXulElement<ICaption<I>>

public interface ICaption<I extends IAnyGroup>
extends ILabelImageElement<ICaption<I>>, IChildrenOfPanel<ICaption<I>>, IChildable<ICaption<I>,I>, IAnyGroup<ICaption<I>>

Immutable Caption component.

A header for a IGroupbox, IWindow, and IPanel. It may contain either a text label, using ILabelElement.withLabel(java.lang.String), or child elements for a more complex caption.

Author:

katherine

See Also:

Caption

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static ICaption<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> ICaption<I>	of(I... children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICaption<I>	of(java.lang.Iterable<? extends I> children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> ICaption<I>	of(java.lang.String label)	Returns the instance with the given label
static <I extends IAnyGroup> ICaption<I>	of(java.lang.String label, java.lang.String image)	Returns the instance with the given label and image
static <I extends IAnyGroup> ICaption<I>	ofId(java.lang.String id)	Returns the instance with the given id.
static <I extends IAnyGroup> ICaption<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, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, 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 ICaption<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.Caption"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

of

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

Returns the instance with the given label

Parameters:

label - The label of the caption

of

static <I extends IAnyGroup> ICaption<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 caption

image - The image of the caption

of

static <I extends IAnyGroup> ICaption<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> ICaption<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> ICaption<I> ofImage(java.lang.String image)

Returns the instance with the given image

Parameters:

image - The image of the caption

ofId

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

Returns the instance with the given id.

Parameters:

id - The id to identify this component