Package org.zkoss.stateless.sul

Interface IDetail<I extends IAnyGroup>

All Superinterfaces:

IChildable<IDetail<I>,I>, IComponent<IDetail<I>>, IDetailChild<IDetail<I>>, IHtmlBasedComponent<IDetail<I>>, IXulElement<IDetail<I>>

public interface IDetail<I extends IAnyGroup>
extends IDetailChild<IDetail<I>>, IChildable<IDetail<I>,I>

Immutable Detail component

The detail component is used to display a detailed section where a master row and multiple detail rows are on the same row.

Support @Action

Name	Action Type
onOpen	ActionData: OpenData Denotes user has opened or closed a component. It is useful to implement load-on-demand by listening to the onOpen action, and creating components when the first time the component is opened.

Author:

katherine

See Also:

Detail

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getContentSclass()	Returns the style class used for the content block.
java.lang.String	getContentStyle()	Returns the CSS style for the content block of the window.
default java.lang.String	getWidgetClass()	Returns the client widget class.
default boolean	isOpen()	Returns whether the detail is open.
static <I extends IAnyGroup> IDetail<I>	of(I... children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> IDetail<I>	of(java.lang.Iterable<? extends I> children)	Returns the instance with the given any group children.
static <I extends IAnyGroup> IDetail<I>	ofId(java.lang.String id)	Returns the instance with the given id.
IDetail<I>	withContentSclass(java.lang.String contentSclass)	Returns a copy of this immutable component with the specified contentSclass.
IDetail<I>	withContentStyle(java.lang.String contentStyle)	Returns a copy of this immutable component with the specified contentStyle.
IDetail<I>	withOpen(boolean open)	Returns a copy of this immutable component with the specified open.

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

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

Field Detail

DEFAULT

static final IDetail<IAnyGroup> DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zkex.grid.Detail"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

getContentSclass

@Nullable
java.lang.String getContentSclass()

Returns the style class used for the content block.

Default: null

withContentSclass

IDetail<I> withContentSclass(@Nullable
                             java.lang.String contentSclass)

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

Sets the style class used for the content block.

Parameters:

contentSclass - The style class used for the content block.

Default: null.

Returns:

A modified copy of the this object

getContentStyle

@Nullable
java.lang.String getContentStyle()

Returns the CSS style for the content block of the window.

Default: null

withContentStyle

IDetail<I> withContentStyle(@Nullable
                            java.lang.String contentStyle)

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

Sets the CSS style for the content block of the window.

Parameters:

contentStyle - The CSS style for the content block of the window.

Default: null.

Returns:

A modified copy of the this object

isOpen

default boolean isOpen()

Returns whether the detail is open.

Default: false

withOpen

IDetail<I> withOpen(boolean open)

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

Sets whether the detail is open.

Parameters:

open - Whether the detail is open.

Default: false.

Returns:

A modified copy of the this object

of

static <I extends IAnyGroup> IDetail<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> IDetail<I> of(I... children)

Returns the instance with the given any group children.

Parameters:

children - The children belong to any group

See Also:

IAnyGroup

ofId

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

Returns the instance with the given id.

Parameters:

id - The id to identify this component