|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LayoutRegion
A layout region in a border layout.
Events:
onOpen, onSize.
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.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Method Detail |
---|
java.lang.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".
void setBorder(java.lang.String border)
border
- the border. If null or "0", "none" is assumed.void setFlex(boolean flex)
java.lang.String getMargins()
Default: "0,0,0,0".
void setMargins(java.lang.String margins)
boolean isAutoscroll()
Default: false.
void setAutoscroll(boolean autoscroll)
java.lang.String getPosition()
Borderlayout.NORTH
,
Borderlayout.SOUTH
,
Borderlayout.EAST
,
Borderlayout.WEST
,
Borderlayout.CENTER
void setSize(java.lang.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
.
java.lang.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
.
java.lang.String getTitle()
Default: null.
void setTitle(java.lang.String title)
boolean isSplittable()
Default: false.
void setSplittable(boolean splittable)
void setMaxsize(int maxsize)
int getMaxsize()
Default: 2000.
void setMinsize(int minsize)
int getMinsize()
Default: 0.
java.lang.String getCmargins()
Default: "5,5,5,5".
void setCmargins(java.lang.String cmargins)
boolean isCollapsible()
Default: false.
void setCollapsible(boolean collapsible)
It only applied when getTitle()
is not null. (since 3.5.0)
boolean isOpen()
isCollapsible()
is not false.
Default: true.
void setOpen(boolean open)
isCollapsible()
is not false.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |