org.zkoss.zul.api
Interface Box

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement
All Known Subinterfaces:
Hbox, Vbox
All Known Implementing Classes:
Box, Hbox, Vbox

public interface Box
extends XulElement

A box.

Default HtmlBasedComponent.getZclass(): z-box.(since 3.5.0)

Since:
3.5.2
Author:
tomyeh

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 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 Component.getMold()).
 java.lang.String getPack()
          Returns the alignment of cells of this box (null, start, center, end).
 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.
 boolean isHorizontal()
          Returns whether it is a horizontal box.
 boolean isVertical()
          Returns whether it is a vertical box.
 void setAlign(java.lang.String align)
          Sets the alignment of cells of this box in the 'opposite' direction (null, start, center, end).
 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 (null, start, center, end).
 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 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

isHorizontal

boolean isHorizontal()
Returns whether it is a horizontal box.


isVertical

boolean isVertical()
Returns whether it is a vertical box.


getOrient

java.lang.String getOrient()
Returns the orient (the same as Component.getMold()).

Default: "vertical".


setOrient

void setOrient(java.lang.String orient)
               throws WrongValueException
Sets the orient.

Parameters:
orient - either "horizontal" or "vertical".
Throws:
WrongValueException

getSpacing

java.lang.String getSpacing()
Returns the spacing between adjacent children, or null if the default spacing is used.

The default spacing depends on the definition of the style class called "xxx-sp", where xxx is

  1. HtmlBasedComponent.getSclass() if it is not null.
  2. hbox if HtmlBasedComponent.getSclass() is null and it is a horizontal box.
  3. vbox if HtmlBasedComponent.getSclass() is null and it is a vertical box.

Default: null (means to use the default spacing).


setSpacing

void setSpacing(java.lang.String spacing)
Sets the spacing between adjacent children.

Parameters:
spacing - the spacing (such as "0", "5px", "3pt" or "1em"), or null to use the default spacing
See Also:
getSpacing()

getAlign

java.lang.String getAlign()
Returns the alignment of cells of a box in the 'opposite' direction (null, start, center, end).

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 algined horizontally. The pack attribute (getPack()) is related to the alignment but is used to specify the position in the opposite direction.

start
Child elements are aligned starting from the left or top edge of the box. If the box is larger than the total size of the children, the extra space is placed on the right or bottom side.
center
Extra space is split equally along each side of the child elements, resulting in the children being placed in the center of the box.
end
Child elements are placed on the right or bottom edge of the box. If the box is larger than the total size of the children, the extra space is placed on the left or top side.


setAlign

void setAlign(java.lang.String align)
Sets the alignment of cells of this box in the 'opposite' direction (null, start, center, end).

Parameters:
align - the alignment in the 'opposite' direction. Allowed values: start, center, end. If empty or null, the browser's default is used (IE center and FF left, if vertical).

getPack

java.lang.String getPack()
Returns the alignment of cells of this box (null, start, center, end).

Default: null.

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.

start
Child elements are aligned starting from the left or top edge of the box. If the box is larger than the total size of the children, the extra space is placed on the right or bottom side.
center
Extra space is split equally along each side of the child elements, resulting in the children being placed in the center of the box.
end
Child elements are placed on the right or bottom edge of the box. If the box is larger than the total size of the children, the extra space is placed on the left or top side.


setPack

void setPack(java.lang.String pack)
Sets the alignment of cells of this box (null, start, center, end).

Parameters:
pack - the alignment. Allowed values: start, center, end. If empty or null, the browser's default is used.

getWidths

java.lang.String getWidths()
Deprecated. As of release 5.0.0, use Cell instead.

Returns the widths/heights, which is a list of numbers separated by comma to denote the width/height of each cell in a box. If 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.


getHeights

java.lang.String getHeights()
Deprecated. As of release 5.0.0, use Cell instead.

Returns the heights/widths, which is a list of numbers separated by comma to denote the height/width of each cell in a box. If 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.


setWidths

void setWidths(java.lang.String widths)
               throws WrongValueException
Deprecated. As of release 5.0.0, use Cell instead.

Sets the widths/heights, which is a list of numbers separated by comma to denote the width/height of each cell in a box.

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.

Throws:
WrongValueException

setHeights

void setHeights(java.lang.String heights)
                throws WrongValueException
Deprecated. As of release 5.0.0, use Cell instead.

Sets the widths/heights, which is a list of numbers separated by comma to denote the width/height of each cell in a box.

It is the same as setWidths(java.lang.String).

Throws:
WrongValueException


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