Package org.zkoss.stateless.sul

Interface INorth<I extends IAnyGroup>

All Superinterfaces:

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

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

Immutable North component

A north region of a border layout.

Author:

katherine

See Also:

• North

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	INorth.Builder<I extends IAnyGroup>	Builds instances of type INorth.
static class	INorth.Updater	Builds an updater of type INorth 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 final INorth<IAnyGroup>	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

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

DEFAULT

static final INorth<IAnyGroup> DEFAULT

Constant for default attributes of this immutable component.

Method Details

getWidgetClass

default String getWidgetClass()

Returns the client widget class.

Default: "zul.layout.North"

Specified by:

getWidgetClass in interface IComponent<I extends IAnyGroup>

getSize

@Lazy
@Nullable
default String getSize()

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

withSize

default INorth<I> withSize(@Nullable
 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 String getCmargins()

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

Default: "3,0,0,3"

withCmargins

INorth<I> withCmargins(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> INorth<I> of(I child)

Return the instance with the given child.

Parameters:

child - The child from any group

ofId

static <I extends IAnyGroup> INorth<I> ofId(String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component