org.zkoss.zul.api
Interface Groupbox

All Superinterfaces:

java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement

All Known Implementing Classes:

Groupbox

public interface Groupbox
extends XulElement

Groups a set of child elements to have a visual effect.

Default HtmlBasedComponent.getZclass(): "z-fieldset". If Component.getMold() is 3d, "z-groupbox" is assumed.(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

Caption	getCaptionApi() Returns the caption of this groupbox.
java.lang.String	getContentSclass() Returns the style class used for the content block of the groupbox.
java.lang.String	getContentStyle() Returns the CSS style for the content block of the groupbox.
boolean	isClosable() Returns whether user can open or close the group box.
boolean	isLegend() Returns whether this groupbox is in the legend mold.
boolean	isOpen() Returns whether this groupbox is open.
void	setClosable(boolean closable) Sets whether user can open or close the group box.
void	setContentSclass(java.lang.String scls) Sets the style class used for the content block.
void	setContentStyle(java.lang.String style) Sets the CSS style for the content block of the groupbox.
void	setLegend(boolean legend) Sets whether this groupbox is in the legend mold.
void	setOpen(boolean open) Opens or closes this groupbox.

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, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Method Detail

getCaptionApi

Caption getCaptionApi()

Returns the caption of this groupbox.

isOpen

boolean isOpen()

Returns whether this groupbox is open.

Default: true.

setOpen

void setOpen(boolean open)

Opens or closes this groupbox.

isClosable

boolean isClosable()

Returns whether user can open or close the group box. In other words, if false, users are no longer allowed to change the open status (by clicking on the title).

Default: true.

setClosable

void setClosable(boolean closable)

Sets whether user can open or close the group box.

getContentStyle

java.lang.String getContentStyle()

Returns the CSS style for the content block of the groupbox. Used only if Component.getMold() is not default.

setContentStyle

void setContentStyle(java.lang.String style)

Sets the CSS style for the content block of the groupbox. Used only if Component.getMold() is not default.

Default: null.

getContentSclass

java.lang.String getContentSclass()

Returns the style class used for the content block of the groupbox. Used only if Component.getMold() is not default.

setContentSclass

void setContentSclass(java.lang.String scls)

Sets the style class used for the content block.

See Also:

getContentSclass()

isLegend

boolean isLegend()

Returns whether this groupbox is in the legend mold. By the legend mold we mean this group box is rendered with HTML FIELDSET tag.

Default: the legend mold is assumed if Component.getMold() returns "default".

If it is not the case, you can call setLegend(boolean) to change it.

setLegend

void setLegend(boolean legend)

Sets whether this groupbox is in the legend mold.

See Also:

isLegend()