JAVA Tech VERSION 3.0 manual General Applet Control, Method isReady

Page 17

General Applet Control

Method: isReady()

E.g. var ready = ViewONE.isReady();

This method returns true if the applet as completed initialization.

If JavaScript is used to open a document during HTML page initialization then this method is useful in determining when ViewONE has fully initialized (prior to opening the document).

Browsers normally initialize Applets in parallel to HTML initialization and so it may be necessary to use this method to synchronize calls to ViewONE. Also, ViewONE itself runs thru an initialization phase in parallel to the loading of a web page.

Note on “object not found” message…

If you receive an “object not found” message while making this (or any JavaScript calls) then it is because the applet has not been started by the browser (ViewONE has not even had a chance to perform it’s own initialization). This message is produced by the browser (not the applet).

The solution is to add some JS code to the call of isReady() which handles object not found (or any use of JavaScript with ViewONE), as follows…

17

Image 17
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 ViewONEApple Macintosh users JavaScript ViewONE ProMayscript parameter 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 ClearHyperlink Document hyperlinksSetHyperlinkurl, dblClick 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 getImageWidthGetImageHeight Method getXResolutionMethod getYResolution GetView ViewingSetViewview IsAreaZoom SetAreaZoomtrue/falseToggleAreaZoom Method setMagnifiertrue/falseMethod setMagnifierInternaltrue/false ToggleMagnifier IsMagnifierSetMagFactor Method getMagFactorShowImageForeColorDialog IsNewWindowVisibleSetImageForeColorcolor ShowImageBackColorDialog SetImageBackColorcolorLabels Method selectPageint pageNumber Selection and clipboardMethod clearSelections Method copyPageToClipboardPrintPage PrintingPrintDocument PrintRangePrintVisible PrintSelectedPrintTransformed SetPrintDialogtrue/falseMethod setPrinterstring Method isPrintDialogMethod setPrintCopiesinteger Or some other informational text Method setPrintHeaderheaderStringMethod setPrintAutoRotate true/false Method setScrollbarstrue/false Toolbars and ButtonsIsScrollbars SetStatusBartrue/falseMethod isFileButtons Method setFileButtonstrue/falseSetPrintButtonstrue/false Method setImageButtonstrue/falseIsImageButtons SetInvertButtonstrue/false Method isPrintButtonsIsInvertButtons Method setNewWindowButtonstrue/falseSetViewButtonstrue/false IsNewWindowButtonsMethod isViewButtons Method setAllButtonstrue/falseMethod isPageButtons Method isAllButtonsMethodsetPageButtonstrue/false IsAdjustToolVisible ToggleAdjustToolSetAdjustToolVisibleOnOff SetFileMenustrue/false Menus and keysIsFileMenus 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 IsAllMenus SetAllMenustrue/falseSetFileKeystrue/false IsFileKeysIsImageKeys SetImageKeystrue/falseSetViewKeystrue/false SetPrintKeystrue/falseIsPrintKeys SetPageKeystrue/false IsViewKeysIsPageKeys SetSelectKeystrue/falseMethod isAllKeys Method isSelectKeysMethod setAllKeystrue/false 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