Package com.saperion.ngc.timer

Class SwitchableTimer

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    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

        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 Description
      SwitchableTimer​(int refreshFolderTimeMilli, boolean allowFireEvents, java.lang.String timerName)
      Constructor with the possibility to allow firing events at construction time.
      SwitchableTimer​(int refreshFolderTimeMilli, java.lang.String timerName)
      Standard Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.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​(java.lang.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

        addSclass, clone, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getPropertyAccess, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, 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, beforeParentChanged, 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, 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

    • Constructor Detail

      • SwitchableTimer

        public SwitchableTimer​(int refreshFolderTimeMilli,
                       java.lang.String timerName)
        Standard Constructor.
        Parameters:
        refreshFolderTimeMilli - - delay.
        timerName - - Name of the timer.

      • SwitchableTimer

        public SwitchableTimer​(int refreshFolderTimeMilli,
                       boolean allowFireEvents,
                       java.lang.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​(java.lang.String timerName)
        Sets the timers name.
        Parameters:
        timerName - the name of the timer to set.

      • getName

        public java.lang.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.
        Overrides:
        start in class org.zkoss.zul.Timer
        See Also:
        Timer.start()

      • stop

        public void stop()
        Disallows firing events internally and stops the 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).
        Overrides:
        setDelay in class org.zkoss.zul.Timer
        Parameters:
        delay - delay / interval for firing events.
        See Also:
        Timer.setDelay(int)