Package org.zkoss.stateless.sul

Interface ISouth<I extends IAnyGroup>

All Superinterfaces:

IComponent<ISouth<I>>, IHtmlBasedComponent<ISouth<I>>, ILayoutRegion<ISouth<I>>, ISingleChildable<ISouth<I>,I>, IXulElement<ISouth<I>>

public interface ISouth<I extends IAnyGroup>
extends ILayoutRegion<ISouth<I>>, ISingleChildable<ISouth<I>,I>

Immutable South component

A south region of a border layout.

Author:

katherine

See Also:

South

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.zkoss.stateless.sul.ILayoutRegion

ILayoutRegion.Border

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getCmargins()	Returns the collapsed margins, which is a list of numbers separated by comma.
default java.lang.String	getSize()	Returns the size of this region.
default java.lang.String	getWidgetClass()	Returns the client widget class.
static <I extends IAnyGroup> ISouth<I>	of(I child)	Return the instance with the given child.
static <I extends IAnyGroup> ISouth<I>	ofId(java.lang.String id)	Returns the instance with the given id.
ISouth<I>	withCmargins(java.lang.String cmargins)	Returns a copy of this immutable component with the specified cmargins.
default ISouth<I>	withSize(java.lang.String size)	Returns a copy of this immutable component with the specified size.

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

getBorder, getMargins, getMaxsize, getMinsize, getTitle, isAutoscroll, isClosable, isCollapsible, isNativeScrollbar, isOpen, isSlidable, isSlide, isSplittable, withAutoscroll, withBorder, withBorder, withClosable, withCollapsible, withMargins, withMaxsize, withMinsize, withNativeScrollbar, withOpen, withSlidable, withSlide, withSplittable, withTitle

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

getChild, withChild

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

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

Field Detail

DEFAULT

static final ISouth<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.layout.South"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

getSize

@Lazy
@Nullable
default java.lang.String getSize()

Returns the size of this region. This method is shortcut for IHtmlBasedComponent.getHeight().

withSize

default ISouth<I> withSize(@Nullable
                           java.lang.String size)

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

This method is shortcut for IHtmlBasedComponent.withHeight(String).

Parameters:

size - The height of the component.

Default: null

Returns:

A modified copy of the this object

getCmargins

default java.lang.String getCmargins()

Returns the collapsed margins, which is a list of numbers separated by comma.

Default: "3,0,0,3"

withCmargins

ISouth<I> withCmargins(java.lang.String cmargins)

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

Sets the collapsed margins for the component "0,1,2,3" that direction is "top,left,right,bottom"

Parameters:

cmargins - The collapsed margins for the component

Default: "3,0,0,3"

Returns:

A modified copy of the this object

of

static <I extends IAnyGroup> ISouth<I> of(I child)

Return the instance with the given child.

Parameters:

child - The child from any group

ofId

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

Returns the instance with the given id.

Parameters:

id - The id to identify this component