Home > Class Reference > ENSLIB namespace > %ZEN.Component.timer
Private  Storage   

%ZEN.Component.timer


class %ZEN.Component.timer extends component

Client-side timer object. This component automatically creates a javascript timer object within the client and initializes it when the page is first loaded. The timer is one-shot; after it fires its ontimeout event, you must restart it by calling the client startTimer method.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 5


Summary


Properties
%condition %import %includeFiles %page
%resource align aux composite
containerStyle dragEnabled dropEnabled enclosingClass
enclosingStyle error height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelStyle name onafterdrag onbeforedrag
ondrag ondrop onhide onrefresh
onshow ontimeout onupdate parent
showLabel slice timeout title
tuple valign visible width
window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType clearTimer dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent getEnclosingDiv
getHidden getHintElement getLabelElement getProperty
getSettings getType invokeSuper isOfType
makeId onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onStartModalHandler onloadHandler onunloadHandler onupdateHandler
refreshContents render renderContents renderSVG
setHidden setOverlayMode setProperty startProgressBar
startTimer stopProgressBar


Parameters


• parameter DEFAULTVISIBLE = 0;
this component is not visible.

Properties


• property ontimeout as %ZEN.Datatype.eventHandler;
ontimeout event handler: Client code to run when timeout expires.
• property timeout as %ZEN.Datatype.integer(MINVAL=0);
Timeout value (in milliseconds).
Setting this to 0 will disable the timer.

Methods


• method clearTimer() [ Language = javascript ]
Clear the timer object used by this component.
• method onDelete() [ Language = javascript ]
This client method, if present, is called when this component is removed from the page.
• method onloadHandler() [ Language = javascript ]
This client event is fired when the page is loaded.
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method startTimer() [ Language = javascript ]
Start the timer.