Package org.zkoss.stateless.sul
Interface IWest<I extends IAnyGroup>
-
- All Superinterfaces:
IComponent<IWest<I>>
,IHtmlBasedComponent<IWest<I>>
,ILayoutRegion<IWest<I>>
,ISingleChildable<IWest<I>,I>
,IXulElement<IWest<I>>
public interface IWest<I extends IAnyGroup> extends ILayoutRegion<IWest<I>>, ISingleChildable<IWest<I>,I>
ImmutableWest
componentA west region of a border layout.
- Author:
- katherine
- See Also:
West
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IWest.Builder<I extends IAnyGroup>
Builds instances of typeIWest
.static class
IWest.Updater
Builds an updater of typeIWest
forUiAgent.smartUpdate(Locator, SmartUpdater)
.-
Nested classes/interfaces inherited from interface org.zkoss.stateless.sul.ILayoutRegion
ILayoutRegion.Border
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods 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>
IWest<I>of(I child)
Return the instance with the given child.static <I extends IAnyGroup>
IWest<I>ofId(java.lang.String id)
Returns the instance with the given id.IWest<I>
withCmargins(java.lang.String cmargins)
Returns a copy ofthis
immutable component with the specifiedcmargins
.default IWest<I>
withSize(java.lang.String size)
Returns a copy ofthis
immutable component with the specifiedsize
.-
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
-
-
-
-
Method Detail
-
getWidgetClass
default java.lang.String getWidgetClass()
Returns the client widget class.Default:
"zul.layout.West"
- Specified by:
getWidgetClass
in interfaceIComponent<I extends IAnyGroup>
-
getSize
@Lazy @Nullable default java.lang.String getSize()
Returns the size of this region. This method is shortcut forIHtmlBasedComponent.getWidth()
.
-
withSize
default IWest<I> withSize(@Nullable java.lang.String size)
Returns a copy ofthis
immutable component with the specifiedsize
.This method is shortcut for
IHtmlBasedComponent.withWidth(String)
.- Parameters:
size
- The width 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:
"0,3,3,0"
-
withCmargins
IWest<I> withCmargins(java.lang.String cmargins)
Returns a copy ofthis
immutable component with the specifiedcmargins
.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 componentDefault:
"0,3,3,0"
- Returns:
- A modified copy of the
this
object
-
of
static <I extends IAnyGroup> IWest<I> of(I child)
Return the instance with the given child.- Parameters:
child
- The child from any group
-
-