Package org.zkoss.stateless.sul

Interface IFoot

All Superinterfaces:

IChildable<IFoot,IFooter<IAnyGroup>>, IComponent<IFoot>, IGridComposite<IFoot>, IHtmlBasedComponent<IFoot>, IMeshComposite<IFoot>, IXulElement<IFoot>

public interface IFoot
extends IXulElement<IFoot>, IChildable<IFoot,IFooter<IAnyGroup>>, IGridComposite<IFoot>

Immutable Foot component

Author:

katherine

See Also:

Foot

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getHflex()	Return horizontal flex hint of this component.
default java.lang.String	getWidgetClass()	Returns the client widget class.
default java.lang.String	getWidth()	Returns the width of the component.
static IFoot	of(java.lang.Iterable<? extends IFooter<IAnyGroup>> children)	Returns the instance with the given footers which belong to this component.
static IFoot	of(IFooter<IAnyGroup>... children)	Returns the instance with the given footers which belong to this component.
static IFoot	ofId(java.lang.String id)	Returns the instance with the given id.
default IFoot	withHflex(java.lang.String hflex)	To control the size of Foot related components, please refer to IGrid and IColumn instead.
default IFoot	withWidth(java.lang.String width)	To control the size of Foot related components, please refer to IGrid and IColumn instead.

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, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withLeft, withRenderdefer, withSclass, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withZclass, withZIndex

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

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

Field Detail

DEFAULT

static final IFoot DEFAULT

Constant for default attributes of this immutable component.

Method Detail

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zul.grid.Foot"

Specified by:

getWidgetClass in interface IComponent<IFoot>

getWidth

@Derived
@Nullable
default java.lang.String getWidth()

Description copied from interface: IHtmlBasedComponent

Returns the width of the component. If not specified, null is assumed.

Default: null

Specified by:

getWidth in interface IHtmlBasedComponent<IFoot>

withWidth

default IFoot withWidth(@Nullable
                        java.lang.String width)

To control the size of Foot related components, please refer to IGrid and IColumn instead.

Specified by:

withWidth in interface IHtmlBasedComponent<IFoot>

Parameters:

width - The width of the component.

Default: null

Returns:

A modified copy of the this object

getHflex

@Derived
@Nullable
default java.lang.String getHflex()

Description copied from interface: IHtmlBasedComponent

Return horizontal flex hint of this component.

Default: null

Specified by:

getHflex in interface IHtmlBasedComponent<IFoot>

withHflex

default IFoot withHflex(@Nullable
                        java.lang.String hflex)

To control the size of Foot related components, please refer to IGrid and IColumn instead.

Specified by:

withHflex in interface IHtmlBasedComponent<IFoot>

Parameters:

hflex - The horizontal flex hint.

Default: null

Returns:

A modified copy of the this object

of

static IFoot of(java.lang.Iterable<? extends IFooter<IAnyGroup>> children)

Returns the instance with the given footers which belong to this component.

Parameters:

children - The footers of the component.

of

static IFoot of(IFooter<IAnyGroup>... children)

Returns the instance with the given footers which belong to this component.

Parameters:

children - The footers of the component.

ofId

static IFoot ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component