org.zkoss.zul

Class Borderlayout

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.Borderlayout

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Borderlayout
extends org.zkoss.zk.ui.HtmlBasedComponent

A border layout is a layout container for arranging and resizing child components to fit in five regions: north, south, east, west, and center. Each region may contain no more than one component, and is identified by a corresponding constant: NORTH, SOUTH, EAST, WEST, and CENTER. When adding a component to a container with a border layout, use one of these five constants, for example:

  <borderlayout>
  <north margins="1,5,1,1" size="20%" splittable="true" collapsible="true" minsize="100" maxsize="400">
  <div>
  North
  </div>
  </north>
  <west size="25%" splittable="true" autoscroll="true">
  <div>
  West
  </div>
  </west>
  <center flex="true">
  <div>
  Center
  </div>
  </center>
  <east size="25%" collapsible="true" onOpen='alert(self.id + " is open :" +event.open)'>
  <div>
  East
  </div>
  </east>
  <south size="50%" splittable="true">
  <div>
  south
  </div>
  </south>
  </borderlayout>
 
 

Default getZclass(): z-borderlayout. (since 3.5.0)

Configuration: you can disable the animation effects by specifying a library property named org.zkoss.zul.borderlayout.animation.disabled to disable all borderlayouts. (since 5.0.8)

Since:

5.0.0

Author:

jumperchen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields

Modifier and Type	Field and Description
static String	CENTER The center layout constraint (middle of container).
static String	EAST The east layout constraint (right side of container).
static String	NORTH The north layout constraint (top of container).
static String	SOUTH The south layout constraint (bottom of container).
static String	WEST The west layout constraint (left side of container).

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Borderlayout()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
Object	clone()
Center	getCenter()
East	getEast()
North	getNorth()
South	getSouth()
West	getWest()
String	getZclass()
boolean	insertBefore(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
boolean	isAnimationDisabled() Returns whether disable animation effects Default: false.
void	onChildRemoved(org.zkoss.zk.ui.Component child)
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	resize() Re-size this layout component.
void	setAnimationDisabled(boolean animationDisabled) Sets to disable animation effects.

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getPropertyAccess, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NORTH

public static final String NORTH

The north layout constraint (top of container).

See Also:

Constant Field Values

SOUTH

public static final String SOUTH

The south layout constraint (bottom of container).

See Also:

Constant Field Values

EAST

public static final String EAST

The east layout constraint (right side of container).

See Also:

Constant Field Values

WEST

public static final String WEST

The west layout constraint (left side of container).

See Also:

Constant Field Values

CENTER

public static final String CENTER

The center layout constraint (middle of container).

See Also:

Constant Field Values

Constructor Detail

Borderlayout

public Borderlayout()

Method Detail

isAnimationDisabled

public boolean isAnimationDisabled()

Returns whether disable animation effects

Default: false.

Since:

5.0.8

setAnimationDisabled

public void setAnimationDisabled(boolean animationDisabled)

Sets to disable animation effects.

Since:

5.0.8

getNorth

public North getNorth()

getSouth

public South getSouth()

getWest

public West getWest()

getEast

public East getEast()

getCenter

public Center getCenter()

resize

public void resize()

Re-size this layout component.

beforeChildAdded

public void beforeChildAdded(org.zkoss.zk.ui.Component child,
                    org.zkoss.zk.ui.Component refChild)

Specified by:

beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent

insertBefore

public boolean insertBefore(org.zkoss.zk.ui.Component child,
                   org.zkoss.zk.ui.Component refChild)

Specified by:

insertBefore in interface org.zkoss.zk.ui.Component

Overrides:

insertBefore in class org.zkoss.zk.ui.AbstractComponent

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class org.zkoss.zk.ui.HtmlBasedComponent

Throws:

IOException

onChildRemoved

public void onChildRemoved(org.zkoss.zk.ui.Component child)

Specified by:

onChildRemoved in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onChildRemoved in class org.zkoss.zk.ui.AbstractComponent

getZclass

public String getZclass()

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

clone

public Object clone()

Specified by:

clone in interface org.zkoss.zk.ui.Component

Overrides:

clone in class org.zkoss.zk.ui.HtmlBasedComponent