JAVA Tech VERSION 3.0 manual Ready

Page 85

 

 

 

event to switch focus to any alternative component on your web page.

 

 

 

 

 

 

 

22

ready

The applet has just been started and is ready to accept JavaScript calls.

 

 

 

 

 

 

 

23

annotation hyperlink

The user has activated an annotation (JavaScript) hyperlink (see

 

 

annotations configuration manual).

 

 

 

 

 

 

 

 

 

 

 

24

annotations save ok

Annotations have just been saved.

 

 

 

 

 

 

 

25

annotations save failed

The annotations save operation has just failed.

 

 

 

 

 

 

 

26

print cancelled

A print dialog or print job has been cancelled.

 

 

 

 

 

 

 

27

print ended

A print job has been successfully sent to the printer.

 

 

 

 

 

 

 

 

 

 

28

 

Reserved.

 

 

 

 

 

 

 

29

 

Reserved.

 

 

 

 

 

 

 

30

annotation created

The user has added an annotation through the user interface.

 

 

 

 

 

 

 

 

 

This event can fire with two different n values…

 

 

 

 

- if n is 1, it means that ViewONE could not create the save files in its own

 

 

31

SaveDocument Failed(n)

cache (prior to sending them to the destination). One way this might

 

 

happen is if the disk was full.

 

 

 

 

 

 

 

 

- if n is 2, it means that ViewONE could not copy the save files to the

 

 

 

 

specified destination.

 

 

 

 

 

 

 

32

annotations updated: page n of n

Gets fired whenever a document’s annotations set is modified. It can,

 

 

therefore, be used to indicate that the document’s annotations now require

 

 

 

 

saving.

 

 

 

 

 

 

 

33

annotations restored: page n of n

Gets fired whenever a document’s annotations set is restored. It can,

 

 

therefore, be used to indicate that the document’s annotations no longer

 

 

 

 

require saving.

 

 

 

 

 

 

 

34

Page rendered

The image for the current page has been rendered/updated. This event

 

 

occurs on every redraw/refresh. See event 38/39 for filtered versions.

 

 

 

 

 

 

 

 

 

 

 

35

Area Selected

An area of the current page has been selected by the user (using the zoom

 

 

area tool).

 

 

 

 

 

 

 

 

 

 

 

36

 

Reserved

 

 

 

 

 

 

 

 

 

A key has been pressed (key defined in the event).

 

 

 

 

Notes:

 

 

 

 

It is strongly recommended that you turn off key processing by ViewONE by

 

 

 

 

using the HTML parameter ProcessKeys set to False, otherwise ViewONE

 

 

 

 

will process keys AND generate events.

 

 

37

Key pressed

It is also strongly recommended that you set up a test to display the event

 

 

text before assuming that value of that text because some keyboards may

 

 

 

 

 

 

 

 

differ in the text and may also differ according to the localization setup of

 

 

 

 

your machine.

 

 

 

 

The following keys do not generate events..

 

 

 

 

- Keys processed when editing a text annotation

 

 

 

 

- SHIFT, CTRL and ALT Keys (instead, when a key is pressed a marker is

 

 

 

 

included to indicate when these keys are pressed with other keys –see

 

 

 

 

examples below)

 

 

 

 

 

 

 

 

 

85

 

Image 85
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