org.zkoss.zul.api
Interface LayoutRegion

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement
All Known Subinterfaces:
Center, Center, East, East, LayoutRegion, North, North, South, South, West, West
All Known Implementing Classes:
Center, Center, East, East, LayoutRegion, LayoutRegion, North, North, South, South, West, West

public interface LayoutRegion
extends XulElement

A layout region in a border layout.

Events:
onOpen, onSize.

Since:
5.0.0
Author:
jumperchen

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 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.
 java.lang.String getPosition()
          Returns this regions position (north/south/east/west/center).
 java.lang.String getSize()
          Returns the size of this region.
 java.lang.String getTitle()
          Returns the title.
 boolean isAutoscroll()
          Returns whether enable overflow scrolling.
 boolean isCollapsible()
          Returns whether set the initial display to collapse.
 boolean isOpen()
          Returns whether it is opne (i.e., not collapsed.
 boolean isSplittable()
          Returns whether enable the split functionality.
 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.
 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 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, getZclass, 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
 

Method Detail

getBorder

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".


setBorder

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

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

setFlex

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


getMargins

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

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


setMargins

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


isAutoscroll

boolean isAutoscroll()
Returns whether enable overflow scrolling.

Default: false.


setAutoscroll

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


getPosition

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

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

setSize

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.


getSize

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.


getTitle

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

Default: null.


setTitle

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


isSplittable

boolean isSplittable()
Returns whether enable the split functionality.

Default: false.


setSplittable

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


setMaxsize

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


getMaxsize

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

Default: 2000.


setMinsize

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


getMinsize

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

Default: 0.


getCmargins

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

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


setCmargins

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


isCollapsible

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

Default: false.


setCollapsible

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

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

Default: true.


setOpen

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



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