JAVA Tech VERSION 3.0 Timeout/User Idle Control, Method setTimeoutseconds, Method getTimeout

Page 80

Timeout/User Idle Control

Method: setTimeout(seconds)

E.g. var ready = ViewONE.setTimeout(30);

This method sets and starts a usage timer. If the user does not use the applet for the number of seconds specified then the applet will automatically be disabled. It can be re- enabled by calling one of the timeout JavaScript methods (see below), opening a document using one of the JavaScript open methods, by revisiting the page containing the applet (Netscape) or reloading the page (Internet Explorer).

Security note: This method is disabled by default unless the “JavascriptExtensions” parameter is set to “true”.

Method: getTimeout()

E.g. var seconds = ViewONE.getTimeout();

This method returns the timeout value (integer seconds) set using either the setTimeout() method or the HTML tag “timeout”.

Method: stopTimeout()

E.g. ViewONE.stopTimeout();

This method will disable the timer set using either the setTimeout() method or the HTML tag “timeout” and if the applet had timed-out then it will wake-up (i.e. be re-enabled).

Security note: This method is disabled by default unless the “JavascriptExtensions” parameter is set to “true”.

Method: isTimedOut()

E.g. var timedout = ViewONE.isTimedOut();

This method returns a value of true if the applet has timed-out as a result of the user not using the applet for the time specified by the setTimeout() method or the HTML tag “timeout”. It otherwise returns false.

80

Image 80
Contents ViewONE JavaScript API Manual Contents Specifying an Annotations File Viewing Toolbars and Buttons Timeout/User Idle Control Introduction Applet user interface Installing ViewONE ViewONE StandardApple Macintosh users JavaScript ViewONE ProMayscript parameter Using ViewONE Standard on IE for Apple Macintosh Apple Macintosh users HtmlSetting up Windows 2003 server Page Page ViewONE JavaScript Overview JavaScript Reference General Applet Control Method isReadyMethod getVersion Opening documents and images OpenFilefilename,CloseDocument ViewONE.closeDocument Closes an open documentPage Method Group Method openListlistFile, ReloadList OpenDocindexNextDoc PrevDoc FirstDoc LastDoc GetDocIndex GetNumDocs MethodgetNumPagesMethodsetPagepage Method getPageMethod nextPage Method previousPageMethodgetDocReference Method getCacheFileSpecifying an Annotations File MethodsetAnnotationFilefilenameSaving documents and images SavefilenameSavePagefilename MethodsaveSelectedfilenameMethodisMultipageTif ClearHyperlink Document hyperlinksSetHyperlinkurl, dblClick Method Pro-Only Method Pro-Only Method Cold Viewing Options Pro-Only SetBackgroundImagefilename, pageNumber SetBackgroundImageEnabledtrue/false IsBackgroundImageEnabledDocument Indexes Pro-Only SetIndexListFileURLImage InvertSetInvertedtrue/false IsInvertedIsEnhancetrue/false SetEnhanceModemodeGetEnhanceMode SetRotationangleMethod initializeRotationArrayint size Method setRotationArrayint angle, intMethod applyRotationArray Method getRotationMethodrotateClockwise Method rotateCounterclockwiseRotate180 SetFlipmodeGetFlip SetScalescaleGetScale GetStatesViewONE.zoom100 Zooms image to 100% full resolution Method setStatesstring statesMethod zoomOut Method zoom100Method setZoomzoom Method setZoomAndXYScrollzoom, x, yMethod zoomAreax, y, width, height, highlight, seconds SetXYScrollx, yMethod setDraggingEnabledtrue/false Method isDraggingEnabledMethod resetBrightness Method setBrightnesspercentMethod resetContrast Method getBrightnessMethod setContrastpercent Method getContrastMethod resetLuminance Method setLuminancepercentMethod getLuminance Method getImageWidthGetImageHeight Method getXResolutionMethod getYResolution GetView ViewingSetViewview SetAreaZoomtrue/false IsAreaZoomToggleAreaZoom Method setMagnifiertrue/falseMethod setMagnifierInternaltrue/false IsMagnifier ToggleMagnifierSetMagFactor Method getMagFactorShowImageForeColorDialog IsNewWindowVisibleSetImageForeColorcolor SetImageBackColorcolor ShowImageBackColorDialogLabels Selection and clipboard Method selectPageint pageNumberMethod clearSelections Method copyPageToClipboardPrinting PrintPagePrintDocument PrintRangePrintSelected PrintVisiblePrintTransformed SetPrintDialogtrue/falseMethod setPrinterstring Method isPrintDialogMethod setPrintCopiesinteger Method setPrintHeaderheaderString Or some other informational textMethod setPrintAutoRotate true/false Toolbars and Buttons Method setScrollbarstrue/falseIsScrollbars SetStatusBartrue/falseMethod setFileButtonstrue/false Method isFileButtonsSetPrintButtonstrue/false Method setImageButtonstrue/falseIsImageButtons Method isPrintButtons SetInvertButtonstrue/falseIsInvertButtons Method setNewWindowButtonstrue/falseIsNewWindowButtons SetViewButtonstrue/falseMethod isViewButtons Method setAllButtonstrue/falseMethod isPageButtons Method isAllButtonsMethodsetPageButtonstrue/false IsAdjustToolVisible ToggleAdjustToolSetAdjustToolVisibleOnOff Menus and keys SetFileMenustrue/falseIsFileMenus ViewONE.setFileMenustrueViewONE.setViewMenustrue SetViewMenustrue/falseIsViewMenus ViewONE.setImageMenustrue SetImageMenustrue/falseIsImageMenus ViewONE.setPrintMenustrue SetPrintMenustrue/falseIsPrintMenus ViewONE.setPageMenustrue SetPageMenustrue/falseIsPageMenus ViewONE.setSelectMenustrue SetSelectMenustrue/falseIsSelectMenus ViewONE.setPreferenceMenustrue SetPreferenceMenustrue/falseIsPreferenceMenus SetAllMenustrue/false IsAllMenusSetFileKeystrue/false IsFileKeysSetImageKeystrue/false IsImageKeysSetViewKeystrue/false SetPrintKeystrue/falseIsPrintKeys IsViewKeys SetPageKeystrue/falseIsPageKeys SetSelectKeystrue/falseMethod isAllKeys Method isSelectKeysMethod setAllKeystrue/false Timeout/User Idle Control Method setTimeoutsecondsMethod getTimeout Method stopTimeoutMethod getTimeLeft Event Handler and Event Handling Events handler change in ViewONE Version Events ids and descriptions DocN Html tag is used see Html manual End tabReady First time the page is viewed Event Handler example HSPACE=0 VSPACE=0Testing your Event Handler MayScript tag