org.zkoss.zul
Class LayoutRegion

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
              extended by org.zkoss.zul.LayoutRegion
All Implemented Interfaces:
Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
Direct Known Subclasses:
Center, East, North, South, West

public abstract class LayoutRegion
extends XulElement

A layout region in a border layout.

Events:
onOpen, onSize.

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 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
LayoutRegion()
           
 
Method Summary
 void beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
           
 void beforeParentChanged(org.zkoss.zk.ui.Component parent)
           
 String getBorder()
          Returns the border.
 String getCmargins()
          Returns the collapsed margins, which is a list of numbers separated by comma.
protected abstract  int[] getDefaultCmargins()
          Returns the default collapsed margin.
 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.
abstract  String getPosition()
          Returns this regions position (north/south/east/west/center).
abstract  String getSize()
          Returns the size of this region.
 String getTitle()
          Returns the title.
 String getZclass()
           
 boolean isAutoscroll()
          Returns whether enable overflow scrolling.
 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 isSplittable()
          Returns whether enable the split functionality.
protected  void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
           
 void service(org.zkoss.zk.au.AuRequest request, boolean everError)
          Processes an AU request.
 void setAutoscroll(boolean autoscroll)
          Sets whether enable overflow scrolling.
 void setBorder(String border)
          Sets the border (either none or normal).
 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.
abstract  void setSize(String size)
          Sets the size of this region.
 void setSplittable(boolean splittable)
          Sets whether enable the split functionality.
 void setTitle(String title)
          Sets the title.
 
Methods inherited from class org.zkoss.zul.impl.XulElement
clone, getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, 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, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LayoutRegion

public LayoutRegion()
Method Detail

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 (HtmlBasedComponent.setClass(java.lang.String)), it overwrites whatever border you specify here.

Default: "normal".


setBorder

public void setBorder(String border)
Sets the border (either none or normal).

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

isFlex

public boolean isFlex()
Returns whether to grow and shrink vertical/horizontal to fit their given space, so called flexibility.

Default: false.


setFlex

public void setFlex(boolean flex)
Sets whether to grow and shrink vertical/horizontal to fit their given space, so called flexibility.


getMargins

public String getMargins()
Returns the margins, which is a list of numbers separated by comma.

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


setMargins

public void setMargins(String margins)
Sets margins for the element "0,1,2,3" that direction is "top,left,right,bottom"


isAutoscroll

public boolean isAutoscroll()
Returns whether enable overflow scrolling.

Default: false.


setAutoscroll

public void setAutoscroll(boolean autoscroll)
Sets whether enable overflow scrolling.


getPosition

public abstract String getPosition()
Returns this regions position (north/south/east/west/center).

See Also:
Borderlayout.NORTH, Borderlayout.SOUTH, Borderlayout.EAST, Borderlayout.WEST, Borderlayout.CENTER

setSize

public abstract void setSize(String size)
Sets the size of this region. This method is shortcut for HtmlBasedComponent.setHeight(String) and HtmlBasedComponent.setWidth(String). If this region is North or South, this method will invoke HtmlBasedComponent.setHeight(String). If this region is West or East, this method will invoke HtmlBasedComponent.setWidth(String). Otherwise it will throw a UnsupportedOperationException.


getSize

public abstract String getSize()
Returns the size of this region. This method is shortcut for HtmlBasedComponent.getHeight() and HtmlBasedComponent.getWidth(). If this region is North or South, this method will invoke HtmlBasedComponent.getHeight(). If this region is West or East, this method will invoke HtmlBasedComponent.getWidth(). Otherwise it will throw a UnsupportedOperationException.


getTitle

public String getTitle()
Returns the title.

Default: null.


setTitle

public void setTitle(String title)
Sets the title.


isSplittable

public boolean isSplittable()
Returns whether enable the split functionality.

Default: false.


setSplittable

public void setSplittable(boolean splittable)
Sets whether enable the split functionality.


setMaxsize

public void setMaxsize(int maxsize)
Sets the maximum size of the resizing element.


getMaxsize

public int getMaxsize()
Returns the maximum size of the resizing element.

Default: 2000.


setMinsize

public void setMinsize(int minsize)
Sets the minimum size of the resizing element.


getMinsize

public int getMinsize()
Returns the minimum size of the resizing element.

Default: 0.


getCmargins

public String getCmargins()
Returns the collapsed margins, which is a list of numbers separated by comma.

See Also:
setCmargins(java.lang.String), getDefaultCmargins()

setCmargins

public void setCmargins(String cmargins)
Sets the collapsed margins for the element "0,1,2,3" that direction is "top,left,right,bottom"

Default: "3,3,3,3" for center, "0,3,3,0" for east and west, and "3,0,0,3" for north and south.

See Also:
getCmargins(), getDefaultCmargins()

getDefaultCmargins

protected abstract int[] getDefaultCmargins()
Returns the default collapsed margin.

Since:
5.0.5

isCollapsible

public boolean isCollapsible()
Returns whether set the initial display to collapse.

It only applied when getTitle() is not null. (since 3.5.0)

Default: false.


setCollapsible

public void setCollapsible(boolean collapsible)
Sets whether set the initial display to collapse.

It only applied when getTitle() is not null. (since 3.5.0)


isOpen

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

Default: true.


setOpen

public void setOpen(boolean open)
Opens or collapses the splitter. Meaningful only if isCollapsible() is not false.


getZclass

public String getZclass()
Overrides:
getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

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

beforeParentChanged

public void beforeParentChanged(org.zkoss.zk.ui.Component parent)
Specified by:
beforeParentChanged in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
beforeParentChanged in class org.zkoss.zk.ui.AbstractComponent

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException
Overrides:
renderProperties in class XulElement
Throws:
IOException

service

public void service(org.zkoss.zk.au.AuRequest request,
                    boolean everError)
Processes an AU request.

Default: in addition to what are handled by service(org.zkoss.zk.au.AuRequest, boolean), it also handles onOpen.

Specified by:
service in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
service in class org.zkoss.zk.ui.HtmlBasedComponent


Copyright © 2011. All Rights Reserved.