org.zkoss.zul
Class Separator

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zk.ui.HtmlBasedComponent
          org.zkoss.zul.impl.XulElement
              org.zkoss.zul.Separator

All Implemented Interfaces:

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

Direct Known Subclasses:

Space

public class Separator
extends XulElement
implements Separator

A separator.

Default 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

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

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

HtmlBasedComponent.ExtraCtrl

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

AbstractComponent.Children

Field Summary

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

_zclass, RS_NO_DISPLAY, RS_NO_HEIGHT, RS_NO_WIDTH

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

_visible

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

Separator()

Separator(java.lang.String orient)

Method Summary

java.lang.String	getHeight() Returns the height.
java.lang.String	getOrient() Returns the orient.
protected java.lang.String	getRealStyle() Returns the real style that will be generated to client (when HtmlBasedComponent.getOuterAttrs() is called).
java.lang.String	getSpacing() Returns the spacing.
java.lang.String	getWidth() Returns the width.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
boolean	isBar() Returns whether to display a visual bar as the separator.
boolean	isChildable() Default: not childable.
boolean	isHorizontal() Returns whether it is a horizontal separator.
boolean	isSpaceWithMargin() Returns whether to use margins for spacing.
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 class org.zkoss.zul.impl.XulElement

getAction, getActionAttrs, getAllOnClickAttrs, getContext, getCtrlKeys, getInnerAttrs, getOuterAttrs, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

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

focus, getAllOnClickAttrs, getDraggable, getDroppable, getLeft, getMoldSclass, getRealSclass, getRealStyleFlags, getSclass, getStyle, getTooltiptext, getTop, getZindex, getZIndex, newExtraCtrl, redraw, setClass, setDraggable, setDroppable, setFocus, setHeight, setLeft, setMoldSclass, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addAnnotation, addAnnotation, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addSharedAnnotationMap, addSharedEventHandlerMap, appendAsapAttr, appendAsapAttr, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, clone, containsVariable, detach, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getCommand, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getMoldURI, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, hasFellow, insertBefore, invalidate, isAsapRequired, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onDrawNewChild, onPageAttached, onPageDetached, onWrongValue, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, smartUpdate, smartUpdate, smartUpdate, smartUpdateDeferred, smartUpdateValues, toString, unsetVariable

Methods inherited from class java.lang.Object

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

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, getLeft, getSclass, getStyle, getTooltiptext, getTop, 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, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Constructor Detail

Separator

public Separator()

Separator

public Separator(java.lang.String orient)

Parameters:

orient - either "horizontal" or "vertical".

Method Detail

getOrient

public java.lang.String getOrient()

Returns the orient.

Default: "horizontal".

Specified by:

getOrient in interface Separator

setOrient

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

Sets the orient.

Specified by:

setOrient in interface Separator

Parameters:

orient - either "horizontal" or "vertical".

Throws:

WrongValueException

isHorizontal

public boolean isHorizontal()

Returns whether it is a horizontal separator.

Specified by:

isHorizontal in interface Separator

Since:

3.0.4

isVertical

public boolean isVertical()

Returns whether it is a vertical separator.

Specified by:

isVertical in interface Separator

Since:

3.0.4

isBar

public boolean isBar()

Returns whether to display a visual bar as the separator.

Default: false

Specified by:

isBar in interface Separator

setBar

public void setBar(boolean bar)

Sets whether to display a visual bar as the separator.

Specified by:

setBar in interface Separator

getSpacing

public java.lang.String getSpacing()

Returns the spacing.

Default: null (depending on CSS).

Specified by:

getSpacing in interface Separator

setSpacing

public void setSpacing(java.lang.String spacing)

Sets the spacing.

Specified by:

setSpacing in interface Separator

Parameters:

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

getWidth

public java.lang.String getWidth()

Description copied from class: HtmlBasedComponent

Returns the width. If null, the best fit is used.

Default: null.

Specified by:

getWidth in interface HtmlBasedComponent

Overrides:

getWidth in class HtmlBasedComponent

getHeight

public java.lang.String getHeight()

Description copied from class: HtmlBasedComponent

Returns the height. If null, the best fit is used.

Default: null.

Specified by:

getHeight in interface HtmlBasedComponent

Overrides:

getHeight in class HtmlBasedComponent

getRealStyle

protected java.lang.String getRealStyle()

Description copied from class: HtmlBasedComponent

Returns the real style that will be generated to client (when HtmlBasedComponent.getOuterAttrs() is called).

Default: this method will append width, height and others to HtmlBasedComponent.setStyle(java.lang.String) (never null).

Use HtmlBasedComponent.getRealStyleFlags() to control what attributes to exclude.

Overrides:

getRealStyle in class HtmlBasedComponent

getZclass

public java.lang.String getZclass()

Description copied from class: HtmlBasedComponent

Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

Default: null (the default value depends on element).

HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

Specified by:

getZclass in interface HtmlBasedComponent

Overrides:

getZclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getSclass(), HtmlBasedComponent.getRealSclass()

isSpaceWithMargin

public boolean isSpaceWithMargin()

Returns whether to use margins for spacing.

Default: false since 3.0.4. It indicates the width and height instead of margins will be used to control the spacing (getSpacing()).

If you want to use margins instead of width/height like 3.0.3 or ealier did, you can specify the sytem property called "org.zkoss.zul.Separator.spaceWithMargin" with a non-empty value. In other words, define it only if you want to apply the 3.0.3-compatible behavior.

Since:

3.0.4

isChildable

public boolean isChildable()

Default: not childable.

Specified by:

isChildable in interface Component

Overrides:

isChildable in class AbstractComponent