JAVA Tech VERSION 3.0 manual MethodgetDocReference, Method getCacheFile

Page 25

Method:getDocReference()

E.g.

Var ref = ViewONE.getDocReference();

Gets the document reference for the document.

Method: getCacheFile()

E.g. var file = ViewONE.getGetCacheFile();

Returns a String value representing the local filename of the displayed image.

If the file was loaded locally then this value will be the actual local image file. If the file was loaded from a web server then this value will be the local ‘cached’ version of the image file.

*Important: This file must not be locked during read operations (or deleted, renamed. moved etc), as the applet will not be able to continue to use it and unpredictable results may occur.

isCacheAccessFailed ()

Returns true if access to the ViewONE cache fails. ViewONE may attempt to write to more than one location before and will only return true from this call if all attempts to write have failed.

25

Image 25
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 ViewONEMayscript parameter ViewONE ProApple 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 SetHyperlinkurl, dblClick Document hyperlinksClearHyperlink 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 getYResolution Method getXResolutionGetImageHeight SetViewview ViewingGetView IsAreaZoom SetAreaZoomtrue/falseToggleAreaZoom Method setMagnifiertrue/falseMethod setMagnifierInternaltrue/false ToggleMagnifier IsMagnifierSetMagFactor Method getMagFactorSetImageForeColorcolor IsNewWindowVisibleShowImageForeColorDialog ShowImageBackColorDialog SetImageBackColorcolorLabels Method selectPageint pageNumber Selection and clipboardMethod clearSelections Method copyPageToClipboardPrintPage PrintingPrintDocument PrintRangePrintVisible PrintSelectedPrintTransformed SetPrintDialogtrue/falseMethod setPrintCopiesinteger Method isPrintDialogMethod setPrinterstring Or some other informational text Method setPrintHeaderheaderStringMethod setPrintAutoRotate true/false Method setScrollbarstrue/false Toolbars and ButtonsIsScrollbars SetStatusBartrue/falseMethod isFileButtons Method setFileButtonstrue/falseIsImageButtons Method setImageButtonstrue/falseSetPrintButtonstrue/false SetInvertButtonstrue/false Method isPrintButtonsIsInvertButtons Method setNewWindowButtonstrue/falseSetViewButtonstrue/false IsNewWindowButtonsMethod isViewButtons Method setAllButtonstrue/falseMethodsetPageButtonstrue/false Method isAllButtonsMethod isPageButtons SetAdjustToolVisibleOnOff ToggleAdjustToolIsAdjustToolVisible SetFileMenustrue/false Menus and keysIsFileMenus 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 IsAllMenus SetAllMenustrue/falseSetFileKeystrue/false IsFileKeysIsImageKeys SetImageKeystrue/falseIsPrintKeys SetPrintKeystrue/falseSetViewKeystrue/false SetPageKeystrue/false IsViewKeysIsPageKeys SetSelectKeystrue/falseMethod setAllKeystrue/false Method isSelectKeysMethod 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