JAVA Tech VERSION 3.0 manual Event Handler and Event Handling

Page 82

The Event Handler and Event Handling

ViewONE introduces the concept of applet JavaScript event handling. This is a mechanism by which it is possible to use JavaScript to monitor user activity and other selected actions performed by the ViewONE applet.

This can be a powerful facility, for example, it allows user activity and usage to be logged and/or actions to be performed dependent on what the user is doing/has done (e.g. charge for specific services like printing, perform actions on double-clicks, monitor documents opened etc).

The event handling is first enabled by the use of the HTML tag “eventHandler” and the MayScript tag (see example below). The eventHandler tag must be set to the name of a JavaScript function conforming to the following specification.

When the applet is initialized, it will call this function, passing it parameters relevant to the action performed as described below.

The JavaScript ‘event handler’ must be specified with two parameters; id (integer) and text (String), but can be any name of your choice, as follows…

Function myEventHandler(id, text)

{

alert(“Event received, id=“+id+”, text=“+text);

}

In this example, the event handler just displays a notice to the user that an event had been received. You are however free to do whatever you need, for example testing the value of the id and text fields then taking further actions as necessary.

82

Image 82
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 CloseDocument Opening documents and imagesOpenFilefilename, ViewONE.closeDocument Closes an open documentPage Method Group Method openListlistFile, NextDoc PrevDoc FirstDoc LastDoc GetDocIndex GetNumDocs ReloadListOpenDocindex MethodgetNumPagesMethod nextPage MethodsetPagepageMethod getPage Method previousPageMethodgetDocReference Method getCacheFileSpecifying an Annotations File MethodsetAnnotationFilefilenameSavePagefilename Saving documents and imagesSavefilename 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 SetIndexListFileURLSetInvertedtrue/false ImageInvert IsInvertedGetEnhanceMode IsEnhancetrue/falseSetEnhanceModemode SetRotationangleMethod applyRotationArray Method initializeRotationArrayint sizeMethod setRotationArrayint angle, int Method getRotationRotate180 MethodrotateClockwiseMethod rotateCounterclockwise SetFlipmodeGetScale GetFlipSetScalescale GetStatesMethod zoomOut ViewONE.zoom100 Zooms image to 100% full resolutionMethod setStatesstring states Method zoom100Method zoomAreax, y, width, height, highlight, seconds Method setZoomzoomMethod setZoomAndXYScrollzoom, x, y SetXYScrollx, yMethod resetBrightness Method setDraggingEnabledtrue/falseMethod isDraggingEnabled Method setBrightnesspercentMethod setContrastpercent Method resetContrastMethod getBrightness Method getContrastMethod getLuminance Method resetLuminanceMethod setLuminancepercent Method getImageWidthMethod getYResolution Method getXResolutionGetImageHeight SetViewview ViewingGetView ToggleAreaZoom SetAreaZoomtrue/falseIsAreaZoom Method setMagnifiertrue/falseMethod setMagnifierInternaltrue/false SetMagFactor IsMagnifierToggleMagnifier Method getMagFactorSetImageForeColorcolor IsNewWindowVisibleShowImageForeColorDialog SetImageBackColorcolor ShowImageBackColorDialogLabels Method clearSelections Selection and clipboardMethod selectPageint pageNumber Method copyPageToClipboardPrintDocument PrintingPrintPage PrintRangePrintTransformed PrintSelectedPrintVisible SetPrintDialogtrue/falseMethod setPrintCopiesinteger Method isPrintDialogMethod setPrinterstring Method setPrintHeaderheaderString Or some other informational textMethod setPrintAutoRotate true/false IsScrollbars Toolbars and ButtonsMethod setScrollbarstrue/false SetStatusBartrue/falseMethod setFileButtonstrue/false Method isFileButtonsIsImageButtons Method setImageButtonstrue/falseSetPrintButtonstrue/false IsInvertButtons Method isPrintButtonsSetInvertButtonstrue/false Method setNewWindowButtonstrue/falseMethod isViewButtons IsNewWindowButtonsSetViewButtonstrue/false Method setAllButtonstrue/falseMethodsetPageButtonstrue/false Method isAllButtonsMethod isPageButtons SetAdjustToolVisibleOnOff ToggleAdjustToolIsAdjustToolVisible IsFileMenus Menus and keysSetFileMenustrue/false 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 SetFileKeystrue/false SetAllMenustrue/falseIsAllMenus IsFileKeysSetImageKeystrue/false IsImageKeysIsPrintKeys SetPrintKeystrue/falseSetViewKeystrue/false IsPageKeys IsViewKeysSetPageKeystrue/false SetSelectKeystrue/falseMethod setAllKeystrue/false Method isSelectKeysMethod isAllKeys Method getTimeout Timeout/User Idle ControlMethod setTimeoutseconds 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