Introduction | JAVA Tech VERSION 3.0 specification

Introduction

ViewONE is a Java applet that extends your web browser so that you can view, zoom, magnify, scroll, pan, rotate and print your images and image documents quickly and easily.

This document is the ViewONE JavaScript Manual and covers how to use and what options are available for the ViewONE JavaScript API.

This document is designed to be used in conjunction with the ViewONE HTML and Installation Manual.

(Please note: This manual does not cover the Javascript API for Annotations, please see the Applet Annotations Configuration Manual)

For further information about ViewONE please consult the following documents…

•ViewONE User Manual

•ViewONE HTML and Installation Manual

•ViewONE Annotations User Manual

•ViewONE Annotations Installation HTML and JavaScript Manual

•Various White Papers for in-depth analysis of specific areas

•Latest ViewONE release notes found at http://www.daeja.com/pub/start/release.html

7

Image 7

JAVA Tech VERSION 3.0 manual Introduction

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 ViewONE Mayscript parameter ViewONE ProApple Macintosh users JavaScript Apple Macintosh users Html Using ViewONE Standard on IE for Apple Macintosh Setting up Windows 2003 server Page Page ViewONE JavaScript Overview JavaScript Reference Method isReady General Applet Control Method getVersion ViewONE.closeDocument Closes an open document Opening documents and imagesOpenFilefilename, CloseDocumentPage Method Group Method openListlistFile, MethodgetNumPages ReloadListOpenDocindex NextDoc PrevDoc FirstDoc LastDoc GetDocIndex GetNumDocs Method previousPage MethodsetPagepageMethod getPage Method nextPage Method getCacheFile MethodgetDocReference MethodsetAnnotationFilefilename Specifying an Annotations File MethodsaveSelectedfilename Saving documents and imagesSavefilename SavePagefilename MethodisMultipageTif SetHyperlinkurl, dblClick Document hyperlinksClearHyperlink Method Pro-Only Method Pro-Only Method Cold Viewing Options Pro-Only SetBackgroundImagefilename, pageNumber IsBackgroundImageEnabled SetBackgroundImageEnabledtrue/false SetIndexListFileURL Document Indexes Pro-Only IsInverted ImageInvert SetInvertedtrue/false SetRotationangle IsEnhancetrue/falseSetEnhanceModemode GetEnhanceMode Method getRotation Method initializeRotationArrayint sizeMethod setRotationArrayint angle, int Method applyRotationArray SetFlipmode MethodrotateClockwiseMethod rotateCounterclockwise Rotate180 GetStates GetFlipSetScalescale GetScale Method zoom100 ViewONE.zoom100 Zooms image to 100% full resolutionMethod setStatesstring states Method zoomOut SetXYScrollx, y Method setZoomzoomMethod setZoomAndXYScrollzoom, x, y Method zoomAreax, y, width, height, highlight, seconds Method setBrightnesspercent Method setDraggingEnabledtrue/falseMethod isDraggingEnabled Method resetBrightness Method getContrast Method resetContrastMethod getBrightness Method setContrastpercent Method getImageWidth Method resetLuminanceMethod setLuminancepercent Method getLuminance Method getYResolution Method getXResolutionGetImageHeight SetViewview ViewingGetView Method setMagnifiertrue/false SetAreaZoomtrue/falseIsAreaZoom ToggleAreaZoom Method setMagnifierInternaltrue/false Method getMagFactor IsMagnifierToggleMagnifier SetMagFactor SetImageForeColorcolor IsNewWindowVisibleShowImageForeColorDialog ShowImageBackColorDialog SetImageBackColorcolor Labels Method copyPageToClipboard Selection and clipboardMethod selectPageint pageNumber Method clearSelections PrintRange PrintingPrintPage PrintDocument SetPrintDialogtrue/false PrintSelectedPrintVisible PrintTransformed Method setPrintCopiesinteger Method isPrintDialogMethod setPrinterstring Or some other informational text Method setPrintHeaderheaderString Method setPrintAutoRotate true/false SetStatusBartrue/false Toolbars and ButtonsMethod setScrollbarstrue/false IsScrollbars Method isFileButtons Method setFileButtonstrue/false IsImageButtons Method setImageButtonstrue/falseSetPrintButtonstrue/false Method setNewWindowButtonstrue/false Method isPrintButtonsSetInvertButtonstrue/false IsInvertButtons Method setAllButtonstrue/false IsNewWindowButtonsSetViewButtonstrue/false Method isViewButtons MethodsetPageButtonstrue/false Method isAllButtonsMethod isPageButtons SetAdjustToolVisibleOnOff ToggleAdjustToolIsAdjustToolVisible ViewONE.setFileMenustrue Menus and keysSetFileMenustrue/false IsFileMenus IsViewMenus SetViewMenustrue/falseViewONE.setViewMenustrue IsImageMenus SetImageMenustrue/falseViewONE.setImageMenustrue IsPrintMenus SetPrintMenustrue/falseViewONE.setPrintMenustrue IsPageMenus SetPageMenustrue/falseViewONE.setPageMenustrue IsSelectMenus SetSelectMenustrue/falseViewONE.setSelectMenustrue IsPreferenceMenus SetPreferenceMenustrue/falseViewONE.setPreferenceMenustrue IsFileKeys SetAllMenustrue/falseIsAllMenus SetFileKeystrue/false IsImageKeys SetImageKeystrue/false IsPrintKeys SetPrintKeystrue/falseSetViewKeystrue/false SetSelectKeystrue/false IsViewKeysSetPageKeystrue/false IsPageKeys Method setAllKeystrue/false Method isSelectKeysMethod isAllKeys Method stopTimeout Timeout/User Idle ControlMethod setTimeoutseconds Method getTimeout Method 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 descriptions Ready First time the page is viewed HSPACE=0 VSPACE=0 Event Handler example MayScript tag Testing your Event Handler