com.saperion.ngc.timer

Class SwitchableTimer

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.Timer

com.saperion.ngc.timer.SwitchableTimer

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.api.Timer

public class SwitchableTimer
extends org.zkoss.zul.Timer

Enhanced Timer. Possibility to allow firing events by a little setter and to turn timer on or off via delay time. If the interval for the refresh time is LT 0 the timer is disabled and not startable.

Author:

chg

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

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
SwitchableTimer(int refreshFolderTimeMilli, boolean allowFireEvents, String timerName) Constructor with the possibility to allow firing events at construction time.
SwitchableTimer(int refreshFolderTimeMilli, String timerName) Standard Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the name of the timer.
boolean	isFireEventsAllowed()
boolean	isTimerTurnedOn()
void	setDelay(int delay) Turns off this delay time is wrong (negative).
void	setFireEventsAllowed(boolean fireEvents)
void	setName(String timerName) Sets the timers name.
void	start() Allows firing events at start time and starts timer afterwards.
void	stop() Disallows firing events internally and stops the timer.

Methods inherited from class org.zkoss.zul.Timer

getDelay, isChildable, isRepeats, isRunning, renderProperties, service, setRepeats, setRunning

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

clone, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

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

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setRenderdefer, 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, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, 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, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Constructor Detail

SwitchableTimer

public SwitchableTimer(int refreshFolderTimeMilli,
               String timerName)

Standard Constructor.

Parameters:

refreshFolderTimeMilli - - delay.

timerName - - Name of the timer.

SwitchableTimer

public SwitchableTimer(int refreshFolderTimeMilli,
               boolean allowFireEvents,
               String timerName)

Constructor with the possibility to allow firing events at construction time. If the interval for the refresh time is LT 0 the timer is disabled and not startable.

Parameters:

refreshFolderTimeMilli - - delay.

allowFireEvents - - Says if firing events is allowed.

timerName - - Name of the timer.

Method Detail

setFireEventsAllowed

public void setFireEventsAllowed(boolean fireEvents)

Parameters:

fireEvents - Sets the permission to fire events.

isFireEventsAllowed

public boolean isFireEventsAllowed()

Returns:

true if the timer is allowed to fire events.

isTimerTurnedOn

public boolean isTimerTurnedOn()

Returns:

timer is turned on if delay time is a non negative value.

setName

public void setName(String timerName)

Sets the timers name.

Parameters:

timerName - the name of the timer to set.

getName

public String getName()

Returns the name of the timer.

Returns:

the name of the timer.

start

public void start()

Allows firing events at start time and starts timer afterwards.

Specified by:

start in interface org.zkoss.zul.api.Timer

Overrides:

start in class org.zkoss.zul.Timer

See Also:

Timer.start()

stop

public void stop()

Disallows firing events internally and stops the timer.

Specified by:

stop in interface org.zkoss.zul.api.Timer

Overrides:

stop in class org.zkoss.zul.Timer

See Also:

Timer.stop()

setDelay

public void setDelay(int delay)

Turns off this delay time is wrong (negative).

Specified by:

setDelay in interface org.zkoss.zul.api.Timer

Overrides:

setDelay in class org.zkoss.zul.Timer

Parameters:

delay - delay / interval for firing events.

See Also:

Timer.setDelay(int)