org.zkoss.zul.api
Interface Separator

All Superinterfaces:

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

All Known Subinterfaces:

Space

All Known Implementing Classes:

Separator, Space

public interface Separator
extends XulElement

A separator.

Default HtmlBasedComponent.getZclass() as follows: (since 3.5.0)

1. Case 1: If getOrient() is vertical and isBar() is false, "z-separator-ver" is assumed
2. Case 2: If getOrient() is vertical and isBar() is true, "z-separator-ver-bar" is assumed
3. Case 3: If getOrient() is horizontal and isBar() is false, "z-separator-hor" is assumed
4. Case 4: If getOrient() is horizontal and isBar() is true, "z-separator-hor-bar" is assumed

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	getOrient() Returns the orient.
java.lang.String	getSpacing() Returns the spacing.
boolean	isBar() Returns whether to display a visual bar as the separator.
boolean	isHorizontal() Returns whether it is a horizontal separator.
boolean	isVertical() Returns whether it is a vertical separator.
void	setBar(boolean bar) Sets whether to display a visual bar as the separator.
void	setOrient(java.lang.String orient) Sets the orient.
void	setSpacing(java.lang.String spacing) Sets the spacing.

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

getOrient

java.lang.String getOrient()

Returns the orient.

Default: "horizontal".

setOrient

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

Sets the orient.

Parameters:

orient - either "horizontal" or "vertical".

Throws:

WrongValueException

isHorizontal

boolean isHorizontal()

Returns whether it is a horizontal separator.

isVertical

boolean isVertical()

Returns whether it is a vertical separator.

isBar

boolean isBar()

Returns whether to display a visual bar as the separator.

Default: false

setBar

void setBar(boolean bar)

Sets whether to display a visual bar as the separator.

getSpacing

java.lang.String getSpacing()

Returns the spacing.

Default: null (depending on CSS).

setSpacing

void setSpacing(java.lang.String spacing)

Sets the spacing.

Parameters:

spacing - the spacing (such as "0", "5px", "3pt" or "1em")