|
||||||||||
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.Box
public class Box
A box.
Default getZclass()
: z-vbox.(since 3.5.0)
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 | |
---|---|
Box()
Default: vertical ( Vbox ). |
|
Box(Component[] children)
Constructor a box by assigning an array of children. |
|
Box(java.lang.String orient)
|
|
Box(java.lang.String orient,
Component[] children)
Constructor a box by assigning an array of children. |
Method Summary | |
---|---|
java.lang.String |
getAlign()
Returns the alignment of cells of a box in the 'opposite' direction (null, start, center, end). |
java.lang.String |
getHeights()
Deprecated. As of release 5.0.0, use Cell instead. |
java.lang.String |
getOrient()
Returns the orient (the same as AbstractComponent.getMold() ). |
java.lang.String |
getPack()
Returns the pack alignment of cells of this box (start, center, end) plus an indication stretch option. |
java.lang.String |
getSpacing()
Returns the spacing between adjacent children, or null if the default spacing is used. |
java.lang.String |
getWidths()
Deprecated. As of release 5.0.0, use Cell instead. |
java.lang.String |
getZclass()
Returns the ZK Cascading Style class(es) for this component. |
boolean |
isHorizontal()
Returns whether it is a horizontal box. |
boolean |
isVertical()
Returns whether it is a vertical box. |
protected void |
renderProperties(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing tags and children. |
void |
setAlign(java.lang.String align)
Sets the alignment of cells of this box in the 'opposite' direction (start, center, end, stretch). |
void |
setHeights(java.lang.String heights)
Deprecated. As of release 5.0.0, use Cell instead. |
void |
setOrient(java.lang.String orient)
Sets the orient. |
void |
setPack(java.lang.String pack)
Sets the alignment of cells of this box (start, center, end) plus an stretch option. |
void |
setSpacing(java.lang.String spacing)
Sets the spacing between adjacent children. |
void |
setWidths(java.lang.String widths)
Deprecated. As of release 5.0.0, use Cell instead. |
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, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex |
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.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Constructor Detail |
---|
public Box()
Vbox
).
public Box(java.lang.String orient)
orient
- either "horizontal" or "vertical".public Box(Component[] children)
children
- an array of children to be addedpublic Box(java.lang.String orient, Component[] children)
children
- an array of children to be addedMethod Detail |
---|
public boolean isHorizontal()
isHorizontal
in interface Box
public boolean isVertical()
isVertical
in interface Box
public java.lang.String getOrient()
AbstractComponent.getMold()
).
Default: "vertical".
getOrient
in interface Box
public void setOrient(java.lang.String orient) throws WrongValueException
setOrient
in interface Box
orient
- either "horizontal" or "vertical".
WrongValueException
public java.lang.String getSpacing()
The default spacing depends on the definition of the style class called "xxx-sp", where xxx is
HtmlBasedComponent.getSclass()
if it is not null.HtmlBasedComponent.getSclass()
is null and it is a horizontal box.HtmlBasedComponent.getSclass()
is null and it is a vertical box.Default: null (means to use the default spacing).
getSpacing
in interface Box
public void setSpacing(java.lang.String spacing)
setSpacing
in interface Box
spacing
- the spacing (such as "0", "5px", "3pt" or "1em"),
or null to use the default spacinggetSpacing()
public java.lang.String getAlign()
Default: start
The align attribute specifies how child elements of the box are aligned,
when the size of the box is larger than the total size of the children. For
boxes that have horizontal orientation, it specifies how its children will
be aligned vertically. For boxes that have vertical orientation, it is used
to specify how its children are aligned horizontally. The pack attribute
(getPack()
) is
related to the alignment but is used to specify the position in the
opposite direction.
getAlign
in interface Box
public void setAlign(java.lang.String align)
setAlign
in interface Box
align
- the alignment in the 'opposite' direction.
Allowed values: start, center, end, stretch.
If empty or null, the browser's default is used
(IE center and FF left, if vertical).public java.lang.String getPack()
Default: start.
The pack attribute specifies where child elements of the box are placed
when the box is larger that the size of the children. For boxes with
horizontal orientation, it is used to indicate the position of children
horizontally. For boxes with vertical orientation, it is used to indicate
the position of children vertically. The align attribute
(getAlign()
)is used to specify
the position in the opposite direction.
Splitter
child inside this Box,
then this Box behaves as if the pack attribute has been set the "stretch"
option; no matter you really specify "stretch" in pack attribute or not.
If given null or simply "stretch" to this pack attribute then it is the
same as "stretch,start"
getPack
in interface Box
public void setPack(java.lang.String pack)
setPack
in interface Box
pack
- the alignment. Allowed values: (start, center, end) plus an
stretch option. If empty or null, it defaults to "stretch,start".getPack()
public java.lang.String getWidths()
Cell
instead.
Hbox
(i.e., getOrient()
is horizontal),
it is a list of widths.
If Vbox
(i.e., getOrient()
is vertical),
it is a list of heights.
It is the same as getHeights()
.
Default: empty.
getWidths
in interface Box
public java.lang.String getHeights()
Cell
instead.
Hbox
(i.e., getOrient()
is horizontal),
it is a list of widths.
If Vbox
(i.e., getOrient()
is vertical),
it is a list of heights.
It is the same as getWidths()
.
Default: empty.
getHeights
in interface Box
public void setWidths(java.lang.String widths) throws WrongValueException
Cell
instead.
It is the same as setHeights(java.lang.String)
.
For example, "10%,20%,30%" means the second cell shall occupy 10% width, the second cell 20%, the third cell 30%, and the following cells don't specify any width.
Note: the splitters are ignored, i.e., they are not cells.
Another example, ",,30%" means the third cell shall occupy 30% width, and the rest of cells don't specify any width. Of course, the real widths depend on the interpretation of the browser.
setWidths
in interface Box
WrongValueException
public void setHeights(java.lang.String heights) throws WrongValueException
Cell
instead.
It is the same as setWidths(java.lang.String)
.
setHeights
in interface Box
WrongValueException
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class XulElement
java.io.IOException
public java.lang.String getZclass()
HtmlBasedComponent
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.
getZclass
in interface HtmlBasedComponent
getZclass
in class HtmlBasedComponent
HtmlBasedComponent.getSclass()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |