zul.layout

Class LayoutRegion

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.layout.LayoutRegion

Direct Known Subclasses:

Center, East, North, South, West

public class LayoutRegion
extends Widget

A layout region in a border layout.

Events:
onOpen, onSize, onSlide.

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getBorder() Returns the border.
String	getCmargins() Returns the collapsed margins, which is a list of numbers separated by comma.
protected Dimension	getCurrentMargins_() Returns the current margins.
String	getMargins() Returns the margins, which is a list of numbers separated by comma.
int	getMaxsize() Returns the maximum size of the resizing element.
int	getMinsize() Returns the minimum size of the resizing element.
String	getTitle() Returns the title.
boolean	isAutoscroll() Returns whether enable overflow scrolling.
boolean	isClosable() Returns whether users can open or close the region.
boolean	isCollapsible() Returns whether set the initial display to collapse.
boolean	isFlex() Returns whether to grow and shrink vertical/horizontal to fit their given space, so called flexibility.
boolean	isOpen() Returns whether it is open (i.e., not collapsed.
boolean	isSlidable() Returns whether users can slide (preview) the region when clicked on a collapsed region.
boolean	isSlide() Returns whether it is slide down.
boolean	isSplittable() Returns whether enable the split functionality.
void	setAutoscroll(boolean autoscroll) Sets whether enable overflow scrolling.
void	setBorder(String border) Sets the border (either none or normal).
void	setClosable(boolean closable) Sets whether users can open or close the region.
void	setCmargins(String cmargins) Sets the collapsed margins for the element "0,1,2,3" that direction is "top,left,right,bottom"
void	setCollapsible(boolean collapsible) Sets whether set the initial display to collapse.
void	setFlex(boolean flex) Sets whether to grow and shrink vertical/horizontal to fit their given space, so called flexibility.
void	setMargins(String margins) Sets margins for the element "0,1,2,3" that direction is "top,left,right,bottom"
void	setMaxsize(int maxsize) Sets the maximum size of the resizing element.
void	setMinsize(int minsize) Sets the minimum size of the resizing element.
void	setOpen(boolean open) Opens or collapses the splitter.
void	setSlidable(boolean slidable) Sets whether users can slide (preview) the region when clicked on a collapsed region.
void	setSlide(boolean slide) Slides down or up the region.
void	setSplittable(boolean splittable) Sets whether enable the split functionality.
void	setTitle(String title) Sets the title.

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isFlex

public boolean isFlex()

Returns whether to grow and shrink vertical/horizontal to fit their given space, so called flexibility.

Default: false.

Returns:

boolean

setFlex

public void setFlex(boolean flex)

Sets whether to grow and shrink vertical/horizontal to fit their given space, so called flexibility.

Parameters:

flex -

getBorder

public String getBorder()

Returns the border.

The border actually controls what CSS class to use: If border is null, it implies "none".

If you also specify the CSS class (Widget.setSclass(_global_.String)), it overwrites whatever border you specify here.

Default: "normal".

Returns:

String

setBorder

public void setBorder(String border)

Sets the border (either none or normal).

Parameters:

border - the border. If null or "0", "none" is assumed.

getTitle

public String getTitle()

Returns the title.

Default: null.

Returns:

String

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title -

isSplittable

public boolean isSplittable()

Returns whether enable the split functionality.

Default: false.

Returns:

boolean

setSplittable

public void setSplittable(boolean splittable)

Sets whether enable the split functionality.

Parameters:

splittable -

getMaxsize

public int getMaxsize()

Returns the maximum size of the resizing element.

Default: 2000.

Returns:

int

setMaxsize

public void setMaxsize(int maxsize)

Sets the maximum size of the resizing element.

Parameters:

maxsize -

getMinsize

public int getMinsize()

Returns the minimum size of the resizing element.

Default: 0.

Returns:

int

setMinsize

public void setMinsize(int minsize)

Sets the minimum size of the resizing element.

Parameters:

minsize -

isCollapsible

public boolean isCollapsible()

Returns whether set the initial display to collapse.

Default: false.

Returns:

boolean

setCollapsible

public void setCollapsible(boolean collapsible)

Sets whether set the initial display to collapse.

It only applied when getTitle() is not null.

Parameters:

collapsible -

isAutoscroll

public boolean isAutoscroll()

Returns whether enable overflow scrolling.

Default: false.

Returns:

boolean

setAutoscroll

public void setAutoscroll(boolean autoscroll)

Sets whether enable overflow scrolling.

Parameters:

autoscroll -

isOpen

public boolean isOpen()

Returns whether it is open (i.e., not collapsed. Meaningful only if isCollapsible() is not false.

Default: true.

Returns:

boolean

setOpen

public void setOpen(boolean open)

Opens or collapses the splitter. Meaningful only if isCollapsible() is not false.

Parameters:

open -

isSlide

public boolean isSlide()

Returns whether it is slide down.

Default: false.

Returns:

boolean

Since:

8.0.2

setSlide

public void setSlide(boolean slide)

Slides down or up the region. Meaningful only if isCollapsible() is not false and isOpen() is false.

Parameters:

slide -

Since:

8.0.2

isSlidable

public boolean isSlidable()

Returns whether users can slide (preview) the region when clicked on a collapsed region. In other words, if false, clicking on a collapsed region will open it instead of sliding.

Default: true.

Returns:

boolean whether users can slide (preview) the region.

Since:

8.5.2

setSlidable

public void setSlidable(boolean slidable)

Sets whether users can slide (preview) the region when clicked on a collapsed region. Meaningful only if isCollapsible() is true and isOpen() is false.

Parameters:

slidable - whether users can slide (preview) the region.

Since:

8.5.2

isClosable

public boolean isClosable()

Returns whether users can open or close the region. In other words, if false, users are no longer allowed to change the open status (by clicking the button on the bar).

Default: true.

Returns:

boolean whether users can open or close the region.

Since:

8.5.2

setClosable

public void setClosable(boolean closable)

Sets whether users can open or close the region. Meaningful only if isCollapsible() is true.

Parameters:

closable - whether users can open or close the region.

Since:

8.5.2

getCmargins

public String getCmargins()

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

Default: "3,3,3,3".

Returns:

String

setCmargins

public void setCmargins(String cmargins)

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

Parameters:

cmargins -

getCurrentMargins_

protected Dimension getCurrentMargins_()

Returns the current margins.

Returns:

Dimension

getMargins

public String getMargins()

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

Default: "0,0,0,0".

Returns:

String

setMargins

public void setMargins(String margins)

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

Parameters:

margins -