org.zkoss.zkmax.zul

Class Step

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zkmax.zul.Step

All Implemented Interfaces:

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

public class Step
extends org.zkoss.zul.impl.XulElement

A step is used for displaying user navigation, it should be placed inside a Stepbar.

Only support browsers that support Flex. (IE10+, Edge, Chrome, Firefox, Safari)

Default getZclass(): z-step.

Since:

9.0.0

Author:

jameschu

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

AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Step()
Step(String title)

Method Summary

Modifier and Type	Method and Description
void	beforeParentChanged(org.zkoss.zk.ui.Component parent)
String	getIconSclass() Returns the icon font
int	getIndex() Returns the index of step in the stepbar.
Stepbar	getStepbar() Returns the stepbar that contains this step.
String	getTitle() Returns the title.
String	getZclass()
protected boolean	isChildable()
boolean	isComplete() Returns whether this step is complete.
boolean	isError() Returns whether this step is in error.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	setComplete(boolean complete) Sets whether this step is complete.
protected void	setCompleteDirectly(boolean complete)
void	setError(boolean error) Sets whether this step is in error.
void	setIconSclass(String iconSclass) Sets the icon font
void	setTitle(String title) Sets the title.

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

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

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

addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, service, 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, beforeChildAdded, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, 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, insertBefore, invalidate, invalidatePartial, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, 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

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

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

invalidatePartial

Constructor Detail

Step

public Step()

Step

public Step(String title)

Method Detail

getTitle

public String getTitle()

Returns the title.

Default: empty.

setTitle

public void setTitle(String title)

Sets the title.

Parameters:

title -

setIconSclass

public void setIconSclass(String iconSclass)

Sets the icon font

Parameters:

iconSclass - a CSS class name for the icon font

getIconSclass

public String getIconSclass()

Returns the icon font

isComplete

public boolean isComplete()

Returns whether this step is complete.

Default: false.

Returns:

whether this step is complete

setComplete

public void setComplete(boolean complete)

Sets whether this step is complete.

Parameters:

complete - whether this step is complete

setCompleteDirectly

protected void setCompleteDirectly(boolean complete)

isError

public boolean isError()

Returns whether this step is in error.

Default: false.

Returns:

whether this step is in error

setError

public void setError(boolean error)

Sets whether this step is in error.

Parameters:

error - whether this step is in error.

getStepbar

public Stepbar getStepbar()

Returns the stepbar that contains this step.

It is the same as AbstractComponent.getParent().

Returns:

stepbar

getIndex

public int getIndex()

Returns the index of step in the stepbar.

Returns:

stepbar

beforeParentChanged

public void beforeParentChanged(org.zkoss.zk.ui.Component parent)

Specified by:

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

Overrides:

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

isChildable

protected boolean isChildable()

Overrides:

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

renderProperties

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

Overrides:

renderProperties in class org.zkoss.zul.impl.XulElement

Throws:

IOException

getZclass

public String getZclass()

Overrides:

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