JAVA Tech VERSION 3.0 manual JavaScript Reference

Page 16

JavaScript Reference

The JavaScript examples in this manual do not refer to their use in any particular context. The examples could be used within functions of a JavaScript program or directly as event handlers to buttons, hyper-links etc. Our web site illustrates such uses; alternatively refer to an appropriate JavaScript guide.

Filenames and hyperlink addresses are expressed using the Internet URL address format (Uniform Resource Locator), e.g. “http://mysite/myimage.tif”. If any part of the address before “myimage.tif” is not included then the applet will assume a base address that is the same as the applet location (the codebase).

With the exception of filenames and hyperlink addresses, all parameters are case insensitive.

Security note: Change since ViewONE 3.0.99 Standard and 1.0.99 Pro

Some Javascript methods are disabled by default and can only be enabled by setting the JavaScripExtensions HTML parameter set to true.

e.g. <PARAM NAME=“JavaScriptExtensions” VALUE=“true”>

This is to prevent unauthorized users from attempting to manipulate ViewONE through Javascript methods in order to obtain access to secure information/documents/annotations.

The methods that are restricted in this manner are clearly marked within this document.

16

Image 16

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 StandardMayscript parameter ViewONE ProApple Macintosh users JavaScript 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 SetHyperlinkurl, dblClick Document hyperlinksClearHyperlink 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 getImageWidthMethod getYResolution Method getXResolutionGetImageHeight SetViewview ViewingGetView SetAreaZoomtrue/false IsAreaZoomToggleAreaZoom Method setMagnifiertrue/falseMethod setMagnifierInternaltrue/false IsMagnifier ToggleMagnifierSetMagFactor Method getMagFactorSetImageForeColorcolor IsNewWindowVisibleShowImageForeColorDialog SetImageBackColorcolor ShowImageBackColorDialogLabels Selection and clipboard Method selectPageint pageNumberMethod clearSelections Method copyPageToClipboardPrinting PrintPagePrintDocument PrintRangePrintSelected PrintVisiblePrintTransformed SetPrintDialogtrue/falseMethod setPrintCopiesinteger Method isPrintDialogMethod setPrinterstring Method setPrintHeaderheaderString Or some other informational textMethod setPrintAutoRotate true/false Toolbars and Buttons Method setScrollbarstrue/falseIsScrollbars SetStatusBartrue/falseMethod setFileButtonstrue/false Method isFileButtonsIsImageButtons Method setImageButtonstrue/falseSetPrintButtonstrue/false Method isPrintButtons SetInvertButtonstrue/falseIsInvertButtons Method setNewWindowButtonstrue/falseIsNewWindowButtons SetViewButtonstrue/falseMethod isViewButtons Method setAllButtonstrue/falseMethodsetPageButtonstrue/false Method isAllButtonsMethod isPageButtons SetAdjustToolVisibleOnOff ToggleAdjustToolIsAdjustToolVisible Menus and keys SetFileMenustrue/falseIsFileMenus ViewONE.setFileMenustrueIsViewMenus SetViewMenustrue/falseViewONE.setViewMenustrue IsImageMenus SetImageMenustrue/falseViewONE.setImageMenustrue IsPrintMenus SetPrintMenustrue/falseViewONE.setPrintMenustrue IsPageMenus SetPageMenustrue/falseViewONE.setPageMenustrue IsSelectMenus SetSelectMenustrue/falseViewONE.setSelectMenustrue IsPreferenceMenus SetPreferenceMenustrue/falseViewONE.setPreferenceMenustrue SetAllMenustrue/false IsAllMenusSetFileKeystrue/false IsFileKeysSetImageKeystrue/false IsImageKeysIsPrintKeys SetPrintKeystrue/falseSetViewKeystrue/false IsViewKeys SetPageKeystrue/falseIsPageKeys SetSelectKeystrue/falseMethod setAllKeystrue/false Method isSelectKeysMethod isAllKeys 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