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:
java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, LayoutRegion, XulElement
Direct Known Subclasses:
Center, East, LayoutRegion, North, South, West

public abstract class LayoutRegion
extends XulElement
implements LayoutRegion

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
HtmlBasedComponent.ExtraCtrl
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
AbstractComponent.Children
 
Field Summary
 
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_height, _left, _top, _width, _zclass
 
Fields inherited from class org.zkoss.zk.ui.AbstractComponent
_visible
 
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(Component child, Component refChild)
          Default: does nothing.
 void beforeParentChanged(Component parent)
          Default: does nothing.
 java.lang.String getBorder()
          Returns the border.
 java.lang.String getCmargins()
          Returns the collapsed margins, which is a list of numbers separated by comma.
 java.lang.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  java.lang.String getPosition()
          Returns this regions position (north/south/east/west/center).
abstract  java.lang.String getSize()
          Returns the size of this region.
 java.lang.String getTitle()
          Returns the title.
 java.lang.String getZclass()
          Returns the ZK Cascading Style class(es) for this component.
 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(ContentRenderer renderer)
          Renders the content of this component, excluding the enclosing tags and children.
 void service(AuRequest request, boolean everError)
          Processes an AU request.
 void setAutoscroll(boolean autoscroll)
          Sets whether enable overflow scrolling.
 void setBorder(java.lang.String border)
          Sets the border (either none or normal).
 void setCmargins(java.lang.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(java.lang.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(java.lang.String size)
          Sets the size of this region.
 void setSplittable(boolean splittable)
          Sets whether enable the split functionality.
 void setTitle(java.lang.String title)
          Sets the title.
 
Methods inherited from class org.zkoss.zul.impl.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, newExtraCtrl, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, clone, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Constructor Detail

LayoutRegion

public LayoutRegion()
Method Detail

getBorder

public java.lang.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".

Specified by:
getBorder in interface LayoutRegion

setBorder

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

Specified by:
setBorder in interface LayoutRegion
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.

Specified by:
setFlex in interface LayoutRegion

getMargins

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

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

Specified by:
getMargins in interface LayoutRegion

setMargins

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

Specified by:
setMargins in interface LayoutRegion

isAutoscroll

public boolean isAutoscroll()
Returns whether enable overflow scrolling.

Default: false.

Specified by:
isAutoscroll in interface LayoutRegion

setAutoscroll

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

Specified by:
setAutoscroll in interface LayoutRegion

getPosition

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

Specified by:
getPosition in interface LayoutRegion
See Also:
Borderlayout.NORTH, Borderlayout.SOUTH, Borderlayout.EAST, Borderlayout.WEST, Borderlayout.CENTER

setSize

public abstract void setSize(java.lang.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.

Specified by:
setSize in interface LayoutRegion

getSize

public abstract java.lang.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.

Specified by:
getSize in interface LayoutRegion

getTitle

public java.lang.String getTitle()
Returns the title.

Default: null.

Specified by:
getTitle in interface LayoutRegion

setTitle

public void setTitle(java.lang.String title)
Sets the title.

Specified by:
setTitle in interface LayoutRegion

isSplittable

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

Default: false.

Specified by:
isSplittable in interface LayoutRegion

setSplittable

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

Specified by:
setSplittable in interface LayoutRegion

setMaxsize

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

Specified by:
setMaxsize in interface LayoutRegion

getMaxsize

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

Default: 2000.

Specified by:
getMaxsize in interface LayoutRegion

setMinsize

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

Specified by:
setMinsize in interface LayoutRegion

getMinsize

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

Default: 0.

Specified by:
getMinsize in interface LayoutRegion

getCmargins

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

Default: "5,5,5,5".

Specified by:
getCmargins in interface LayoutRegion

setCmargins

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

Specified by:
setCmargins in interface LayoutRegion

isCollapsible

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

Default: false.

Specified by:
isCollapsible in interface LayoutRegion

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)

Specified by:
setCollapsible in interface LayoutRegion

isOpen

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

Default: true.

Specified by:
isOpen in interface LayoutRegion

setOpen

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

Specified by:
setOpen in interface LayoutRegion

getZclass

public java.lang.String getZclass()
Description copied from class: HtmlBasedComponent
Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

Default: null (the default value depends on element).

HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

Specified by:
getZclass in interface HtmlBasedComponent
Overrides:
getZclass in class HtmlBasedComponent
See Also:
HtmlBasedComponent.getSclass()

beforeChildAdded

public void beforeChildAdded(Component child,
                             Component refChild)
Description copied from class: AbstractComponent
Default: does nothing.

Specified by:
beforeChildAdded in interface ComponentCtrl
Overrides:
beforeChildAdded in class AbstractComponent
Parameters:
child - the child to be added (never null).
refChild - another child component that the new child will be inserted before it. If null, the new child will be the last child.
See Also:
ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)

beforeParentChanged

public void beforeParentChanged(Component parent)
Description copied from class: AbstractComponent
Default: does nothing.

Specified by:
beforeParentChanged in interface ComponentCtrl
Overrides:
beforeParentChanged in class AbstractComponent
Parameters:
parent - the new parent. If null, it means detachment.
See Also:
ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException
Description copied from class: HtmlBasedComponent
Renders the content of this component, excluding the enclosing tags and children.

See also Render Special Properties

Overrides:
renderProperties in class XulElement
Throws:
java.io.IOException

service

public void service(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 ComponentCtrl
Overrides:
service in class HtmlBasedComponent
everError - whether any error ever occured before processing this request.
See Also:
AbstractComponent.setAuService(org.zkoss.zk.au.AuService)


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo