|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.LayoutRegion
public abstract class LayoutRegion
A layout region in a border layout.
Events:
onOpen, onSize.
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 |
---|
public LayoutRegion()
Method Detail |
---|
public String getBorder()
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".
public void setBorder(String border)
border
- the border. If null or "0", "none" is assumed.public boolean isFlex()
Default: false.
public void setFlex(boolean flex)
public String getMargins()
Default: "0,0,0,0".
public void setMargins(String margins)
public boolean isAutoscroll()
Default: false.
public void setAutoscroll(boolean autoscroll)
public abstract String getPosition()
Borderlayout.NORTH
,
Borderlayout.SOUTH
,
Borderlayout.EAST
,
Borderlayout.WEST
,
Borderlayout.CENTER
public abstract void setSize(String size)
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
.
public abstract String getSize()
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
.
public String getTitle()
Default: null.
public void setTitle(String title)
public boolean isSplittable()
Default: false.
public void setSplittable(boolean splittable)
public void setMaxsize(int maxsize)
public int getMaxsize()
Default: 2000.
public void setMinsize(int minsize)
public int getMinsize()
Default: 0.
public String getCmargins()
setCmargins(java.lang.String)
,
getDefaultCmargins()
public void setCmargins(String cmargins)
Default: "3,3,3,3" for center, "0,3,3,0" for east and west, and "3,0,0,3" for north and south.
getCmargins()
,
getDefaultCmargins()
protected abstract int[] getDefaultCmargins()
public boolean isCollapsible()
It only applied when getTitle()
is not null. (since 3.5.0)
Default: false.
public void setCollapsible(boolean collapsible)
It only applied when getTitle()
is not null. (since 3.5.0)
public boolean isOpen()
isCollapsible()
is not false.
Default: true.
public void setOpen(boolean open)
isCollapsible()
is not false.
public String getZclass()
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
public void beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
beforeChildAdded
in interface org.zkoss.zk.ui.sys.ComponentCtrl
beforeChildAdded
in class org.zkoss.zk.ui.AbstractComponent
public void beforeParentChanged(org.zkoss.zk.ui.Component parent)
beforeParentChanged
in interface org.zkoss.zk.ui.sys.ComponentCtrl
beforeParentChanged
in class org.zkoss.zk.ui.AbstractComponent
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws IOException
renderProperties
in class XulElement
IOException
public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
Default: in addition to what are handled by service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onOpen.
service
in interface org.zkoss.zk.ui.sys.ComponentCtrl
service
in class org.zkoss.zk.ui.HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |