org.zkoss.zul.api
Interface Timer

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable
All Known Implementing Classes:
Timer

public interface Timer
extends HtmlBasedComponent

Fires one or more Event after a specified delay.

Timer is a special component that is invisible.

Notice that the timer won't fire any event until it is attached to a page.

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
 int getDelay()
          Returns the delay, the number of milliseconds between successive action events.
 boolean isRepeats()
          Returns whether the timer shall send Event repeatly.
 boolean isRunning()
          Returns whether this timer is running.
 void setDelay(int delay)
          Sets the delay, the number of milliseconds between successive action events.
 void setRepeats(boolean repeats)
          Sets whether the timer shall send Event repeatly.
 void setRunning(boolean running)
          Start or stops the timer.
 void start()
          Starts the timer.
 void stop()
          Stops the timer.
 
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, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

getDelay

int getDelay()
Returns the delay, the number of milliseconds between successive action events.

Default: 0 (immediately).


setDelay

void setDelay(int delay)
              throws WrongValueException
Sets the delay, the number of milliseconds between successive action events.

Throws:
WrongValueException

isRepeats

boolean isRepeats()
Returns whether the timer shall send Event repeatly.

Default: false.


setRepeats

void setRepeats(boolean repeats)
Sets whether the timer shall send Event repeatly.


isRunning

boolean isRunning()
Returns whether this timer is running.

Default: true.

See Also:
stop(), start()

setRunning

void setRunning(boolean running)
Start or stops the timer.


stop

void stop()
Stops the timer.


start

void start()
Starts the timer.



Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo