org.zkoss.zul

Class Groupbox

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Groupbox

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Groupbox
extends XulElement

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

Default getZclass(): "z-groupbox". If AbstractComponent.getMold() is 3d, "z-groupbox-3d" is assumed.(since 3.5.0)

Events: onOpen.

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from class org.zkoss.zk.ui.AbstractComponent

AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED

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

Constructors

Constructor and Description
Groupbox()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
Object	clone()
Caption	getCaption() Returns the caption of this groupbox.
String	getContentSclass() Returns the style class used for the content block of the groupbox.
String	getContentStyle() Returns the CSS style for the content block of the groupbox.
String	getTitle() Returns the title.
String	getZclass()
boolean	insertBefore(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
boolean	isClosable() Returns whether user can open or close the group box.
boolean	isLegend() Deprecated. As of release 6.0, legend no longer used in groupbox.
boolean	isOpen() Returns whether this groupbox is open.
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	setClosable(boolean closable) Sets whether user can open or close the group box.
void	setContentSclass(String scls) Sets the style class used for the content block.
void	setContentStyle(String style) Sets the CSS style for the content block of the groupbox.
void	setLegend(boolean legend) Deprecated. As of release 6.0, legend no longer used in groupbox.
void	setOpen(boolean open) Opens or closes this groupbox.
void	setTitle(String title) Sets the title.

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

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

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, 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

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Groupbox

public Groupbox()

Method Detail

getCaption

public Caption getCaption()

Returns the caption of this groupbox.

isOpen

public boolean isOpen()

Returns whether this groupbox is open.

Default: true.

setOpen

public void setOpen(boolean open)

Opens or closes this groupbox.

isClosable

public 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

public void setClosable(boolean closable)

Sets whether user can open or close the group box.

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class XulElement

Throws:

IOException

getZclass

public String getZclass()

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

getContentStyle

public String getContentStyle()

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

setContentStyle

public void setContentStyle(String style)

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

Default: null.

getContentSclass

public String getContentSclass()

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

setContentSclass

public void setContentSclass(String scls)

Sets the style class used for the content block.

Since:

3.0.0

See Also:

getContentSclass()

getTitle

public String getTitle()

Returns the title. Besides this attribute, you could use Caption to define a more sophisticated caption (a.k.a., title).

It will be displayed before caption.

Default: empty.

Since:

6.0.0

setTitle

public void setTitle(String title)

Sets the title.

Since:

6.0.0

isLegend

public boolean isLegend()

Deprecated. As of release 6.0, legend no longer used in groupbox.

setLegend

public void setLegend(boolean legend)

Deprecated. As of release 6.0, legend no longer used in groupbox.

beforeChildAdded

public void beforeChildAdded(org.zkoss.zk.ui.Component child,
                    org.zkoss.zk.ui.Component refChild)

Specified by:

beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent

insertBefore

public boolean insertBefore(org.zkoss.zk.ui.Component child,
                   org.zkoss.zk.ui.Component refChild)

Specified by:

insertBefore in interface org.zkoss.zk.ui.Component

Overrides:

insertBefore in class org.zkoss.zk.ui.AbstractComponent

onChildRemoved

public void onChildRemoved(org.zkoss.zk.ui.Component child)

Specified by:

onChildRemoved in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onChildRemoved in class org.zkoss.zk.ui.AbstractComponent

service

public void service(org.zkoss.zk.au.AuRequest request,
           boolean everError)

Processes an AU request.

Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onOpen.

Specified by:

service in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

service in class org.zkoss.zk.ui.HtmlBasedComponent

Since:

5.0.0

clone

public Object clone()

Specified by:

clone in interface org.zkoss.zk.ui.Component

Overrides:

clone in class XulElement