org.zkoss.zul.api
Interface Detail

All Superinterfaces:

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

All Known Implementing Classes:

Detail

public interface Detail
extends XulElement

The detail component is used to display a detailed section where a master row and multiple detail rows are on the same row.

Event:

1. onOpen is sent when this component is opened or closed by user.

Default HtmlBasedComponent.getZclass(): z-detail.

Default HtmlBasedComponent.getWidth(): 18px. It depends on the width of the icon of the detail.

Since:

3.5.2

Author:

jumperchen

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	getContentSclass() Returns the style class used for the content block.
java.lang.String	getContentStyle() Returns the CSS style for the content block of the window.
java.lang.String	getImage() Returns the URI of the button image.
boolean	isOpen() Returns whether the detail is open.
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 window.
void	setImage(java.lang.String img) Sets the URI of the button image.
void	setOpen(boolean open) Sets whether the detail is open.

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

getContentStyle

java.lang.String getContentStyle()

Returns the CSS style for the content block of the window.

setContentStyle

void setContentStyle(java.lang.String style)

Sets the CSS style for the content block of the window.

Default: null.

getContentSclass

java.lang.String getContentSclass()

Returns the style class used for the content block.

setContentSclass

void setContentSclass(java.lang.String scls)

Sets the style class used for the content block.

getImage

java.lang.String getImage()

Returns the URI of the button image.

setImage

void setImage(java.lang.String img)

Sets the URI of the button image.

Parameters:

img - the URI of the button image. If null or empty, the default URI is used.

setOpen

void setOpen(boolean open)

Sets whether the detail is open.

isOpen

boolean isOpen()

Returns whether the detail is open.