JAVA Tech VERSION 3.0 manual Method getTimeLeft

Page 81

Method: getTimeLeft()

E.g. var timeleft = ViewONE.getTimeLeft();

This method returns the time in seconds left before the applet times-out. but only if the setTimeout() method or HTML tag “timeout” has been used to set the time in the first place. It otherwise returns 0. The time left is automatically reset each time the user performs any action, such as scrolling, changing pages, zooming etc.

Method: wakeUp()

E.g. ViewONE.wakeUp();

This method will wake-up the applet if it has timed out (see setTimeout()). The user will then be able to use the applet as normal.

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

81

Image 81
Contents ViewONE JavaScript API Manual Contents Specifying an Annotations File Viewing Toolbars and Buttons Timeout/User Idle Control Introduction Applet user interface ViewONE Standard Installing ViewONEViewONE Pro Mayscript parameterApple Macintosh users JavaScript Apple Macintosh users Html Using ViewONE Standard on IE for Apple MacintoshSetting up Windows 2003 server Page Page ViewONE JavaScript Overview JavaScript Reference Method isReady General Applet ControlMethod getVersion OpenFilefilename, Opening documents and imagesCloseDocument ViewONE.closeDocument Closes an open documentPage Method Group Method openListlistFile, OpenDocindex ReloadListNextDoc PrevDoc FirstDoc LastDoc GetDocIndex GetNumDocs MethodgetNumPagesMethod getPage MethodsetPagepageMethod nextPage Method previousPageMethod getCacheFile MethodgetDocReferenceMethodsetAnnotationFilefilename Specifying an Annotations FileSavefilename Saving documents and imagesSavePagefilename MethodsaveSelectedfilenameMethodisMultipageTif Document hyperlinks SetHyperlinkurl, dblClickClearHyperlink Method Pro-Only Method Pro-Only Method Cold Viewing Options Pro-Only SetBackgroundImagefilename, pageNumber IsBackgroundImageEnabled SetBackgroundImageEnabledtrue/falseSetIndexListFileURL Document Indexes Pro-OnlyInvert ImageSetInvertedtrue/false IsInvertedSetEnhanceModemode IsEnhancetrue/falseGetEnhanceMode SetRotationangleMethod setRotationArrayint angle, int Method initializeRotationArrayint sizeMethod applyRotationArray Method getRotationMethod rotateCounterclockwise MethodrotateClockwiseRotate180 SetFlipmodeSetScalescale GetFlipGetScale GetStatesMethod setStatesstring states ViewONE.zoom100 Zooms image to 100% full resolutionMethod zoomOut Method zoom100Method setZoomAndXYScrollzoom, x, y Method setZoomzoomMethod zoomAreax, y, width, height, highlight, seconds SetXYScrollx, yMethod isDraggingEnabled Method setDraggingEnabledtrue/falseMethod resetBrightness Method setBrightnesspercentMethod getBrightness Method resetContrastMethod setContrastpercent Method getContrastMethod setLuminancepercent Method resetLuminanceMethod getLuminance Method getImageWidthMethod getXResolution Method getYResolutionGetImageHeight Viewing SetViewviewGetView IsAreaZoom SetAreaZoomtrue/falseToggleAreaZoom Method setMagnifiertrue/falseMethod setMagnifierInternaltrue/false ToggleMagnifier IsMagnifierSetMagFactor Method getMagFactorIsNewWindowVisible SetImageForeColorcolorShowImageForeColorDialog ShowImageBackColorDialog SetImageBackColorcolorLabels Method selectPageint pageNumber Selection and clipboardMethod clearSelections Method copyPageToClipboardPrintPage PrintingPrintDocument PrintRangePrintVisible PrintSelectedPrintTransformed SetPrintDialogtrue/falseMethod isPrintDialog Method setPrintCopiesintegerMethod setPrinterstring Or some other informational text Method setPrintHeaderheaderStringMethod setPrintAutoRotate true/false Method setScrollbarstrue/false Toolbars and ButtonsIsScrollbars SetStatusBartrue/falseMethod isFileButtons Method setFileButtonstrue/falseMethod setImageButtonstrue/false IsImageButtonsSetPrintButtonstrue/false SetInvertButtonstrue/false Method isPrintButtonsIsInvertButtons Method setNewWindowButtonstrue/falseSetViewButtonstrue/false IsNewWindowButtonsMethod isViewButtons Method setAllButtonstrue/falseMethod isAllButtons MethodsetPageButtonstrue/falseMethod isPageButtons ToggleAdjustTool SetAdjustToolVisibleOnOffIsAdjustToolVisible SetFileMenustrue/false Menus and keysIsFileMenus ViewONE.setFileMenustrueSetViewMenustrue/false IsViewMenusViewONE.setViewMenustrue SetImageMenustrue/false IsImageMenusViewONE.setImageMenustrue SetPrintMenustrue/false IsPrintMenusViewONE.setPrintMenustrue SetPageMenustrue/false IsPageMenusViewONE.setPageMenustrue SetSelectMenustrue/false IsSelectMenusViewONE.setSelectMenustrue SetPreferenceMenustrue/false IsPreferenceMenusViewONE.setPreferenceMenustrue IsAllMenus SetAllMenustrue/falseSetFileKeystrue/false IsFileKeysIsImageKeys SetImageKeystrue/falseSetPrintKeystrue/false IsPrintKeysSetViewKeystrue/false SetPageKeystrue/false IsViewKeysIsPageKeys SetSelectKeystrue/falseMethod isSelectKeys Method setAllKeystrue/falseMethod isAllKeys Method setTimeoutseconds Timeout/User Idle ControlMethod getTimeout Method stopTimeoutMethod getTimeLeft Event Handler and Event Handling Events handler change in ViewONE Version DocN Html tag is used see Html manual End tab Events ids and descriptionsReady First time the page is viewed HSPACE=0 VSPACE=0 Event Handler exampleMayScript tag Testing your Event Handler