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:

java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.sys.ComponentCtrl

public class Groupbox
extends XulElement

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

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

protected class

Groupbox.ExtraCtrl A utility class to implement AbstractComponent.getExtraCtrl().

Field Summary

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

RS_NO_DISPLAY, RS_NO_HEIGHT, RS_NO_WIDTH

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Constructor Summary

Groupbox()

Method Summary

Caption	getCaption() 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.
java.lang.String	getOuterAttrs()
boolean	insertBefore(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component insertBefore)
boolean	isClosable() Returns whether user can open or close the group box.
boolean	isOpen() Returns whether this groupbox is open.
protected java.lang.Object	newExtraCtrl()
void	onChildRemoved(org.zkoss.zk.ui.Component child)
void	setClosable(boolean closable) Sets whether user can open or close the group box.
void	setContentStyle(java.lang.String style) Sets the CSS style for the content block of the groupbox.
void	setOpen(boolean open) Opens or closes this groupbox.

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

getAction, getAllOnClickAttrs, getContext, getInnerAttrs, getPopup, getTooltip, setAction, setContext, setPopup, setTooltip

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

addEventListener, appendAsapAttr, focus, getDraggable, getDroppable, getHeight, getLeft, getRealStyle, getRealStyleFlags, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZIndex, isAsapRequired, removeEventListener, setClass, setDraggable, setDroppable, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZIndex

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

addAnnotation, addAnnotation, addEventHandler, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, clone, containsVariable, detach, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getEventHandler, getExtraCtrl, getFellow, getFellowIfAny, getId, getListenerIterator, getMold, getMoldURI, getNamespace, getPage, getParent, getPropagatee, getRoot, getSpaceOwner, getUuid, getVariable, invalidate, isChildable, isListenerAvailable, isVisible, onChildAdded, onDrawNewChild, onWrongValue, redraw, removeAttribute, removeAttribute, removeChild, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setParent, setVariable, setVisible, smartUpdate, smartUpdate, smartUpdate, toString, unsetVariable

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.

Note: the default mold (AbstractComponent.getMold()) doesn't support the open attribute.

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.

getContentStyle

public java.lang.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(java.lang.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 java.lang.String getContentSclass()

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

If HtmlBasedComponent.getSclass() is null, "gc-default" is returned, Otherwise, "gc-sclass", where sclass is the value returned by HtmlBasedComponent.getSclass().

getOuterAttrs

public java.lang.String getOuterAttrs()

Overrides:

getOuterAttrs in class XulElement

insertBefore

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

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.Component

Overrides:

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

newExtraCtrl

protected java.lang.Object newExtraCtrl()

Overrides:

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