public abstract class LayoutRegion extends XulElement
Events:
onOpen, onSize.
AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED
Constructor and Description |
---|
LayoutRegion() |
Modifier and Type | Method and Description |
---|---|
void |
beforeChildAdded(org.zkoss.zk.ui.Component child,
org.zkoss.zk.ui.Component refChild) |
void |
beforeParentChanged(org.zkoss.zk.ui.Component parent) |
Object |
clone() |
String |
getBorder()
Returns the border.
|
Caption |
getCaption()
Returns the caption of this region.
|
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 |
insertBefore(org.zkoss.zk.ui.Component child,
org.zkoss.zk.ui.Component refChild) |
boolean |
isAutoscroll()
Returns whether enable overflow scrolling.
|
boolean |
isCollapsible()
Returns whether set the initial display to collapse.
|
boolean |
isFlex()
Deprecated.
As of release 6.0.2, use
HtmlBasedComponent.getHflex() and HtmlBasedComponent.getVflex() on child component instead
Default: false. |
boolean |
isOpen()
Returns whether it is open (i.e., not collapsed.
|
boolean |
isSlide() |
boolean |
isSplittable()
Returns whether enable the split functionality.
|
void |
onChildRemoved(org.zkoss.zk.ui.Component child) |
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)
Deprecated.
As of release 6.0.2, use
HtmlBasedComponent.setHflex(String) and HtmlBasedComponent.setVflex(String) on child component instead |
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 |
setSlide(boolean slide) |
void |
setSplittable(boolean splittable)
Sets whether enable the split functionality.
|
void |
setTitle(String title)
Sets the title.
|
getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, 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, getShadowFellowIfAny, getShadowRoots, getShadowVariable, 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, removeCallback, 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
public Caption getCaption()
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()
HtmlBasedComponent.getHflex()
and HtmlBasedComponent.getVflex()
on child component instead
Default: false.
public void setFlex(boolean flex)
HtmlBasedComponent.setHflex(String)
and HtmlBasedComponent.setVflex(String)
on child component insteadpublic 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()
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()
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 boolean isSlide()
public void setSlide(boolean slide)
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
public boolean insertBefore(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
insertBefore
in interface org.zkoss.zk.ui.Component
insertBefore
in class org.zkoss.zk.ui.AbstractComponent
public void onChildRemoved(org.zkoss.zk.ui.Component child)
onChildRemoved
in interface org.zkoss.zk.ui.sys.ComponentCtrl
onChildRemoved
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
public Object clone()
clone
in interface org.zkoss.zk.ui.Component
clone
in class XulElement
Copyright © 2017. All rights reserved.