org.faceless.pdf2
Class JSEvent

java.lang.Object
  extended by org.faceless.pdf2.JSEvent

public class JSEvent
extends Object

Represents the JavaScript "Event" class. See the Acrobat JavaScript Reference for the full definition.

Since:
2.9

Method Summary
static JSEvent createAppInit()
          Return a new "App/Init" event
static JSEvent createBatchExec(PDF pdf, String javascript)
          Return a new "Batch/Exec" event
static JSEvent createBookmarkMouseUp(PDFBookmark bookmark)
          Return a new "Bookmark/Mouse Up" event
static JSEvent createConsoleExec(PDF pdf, String javascript)
          Return a new "Console/Exec" event
static JSEvent createDocDidPrint(PDF pdf)
          Return a new "Doc/DidPrint" event
static JSEvent createDocDidSave(PDF pdf)
          Return a new "Doc/DidSave" event
static JSEvent createDocOpen(PDF pdf, String targetName)
          Return a new "Doc/Open" event
static JSEvent createDocWillClose(PDF pdf)
          Return a new "Doc/WillClose" event
static JSEvent createDocWillPrint(PDF pdf)
          Return a new "Doc/WillPrint" event
static JSEvent createDocWillSave(PDF pdf)
          Return a new "Doc/WillSave" event
static JSEvent createExternalExec(String javascript)
          Return a new "External/Exec" event
static JSEvent createFieldBlur(WidgetAnnotation annot, boolean shift, boolean modifier)
          Return a new "Field/Blur" event
static JSEvent createFieldCalculate(WidgetAnnotation target, WidgetAnnotation source)
          Return a new "Field/Calculate" event
static JSEvent createFieldFocus(WidgetAnnotation annot, boolean shift, boolean modifier)
          Return a new "Field/Focus" event
static JSEvent createFieldFormat(WidgetAnnotation annot, int commitKey, boolean willCommit)
          Return a new "Field/Format" event
static JSEvent createFieldKeystroke(WidgetAnnotation annot, int commitKey, String change, String changeEx, boolean fieldFull, boolean keyDown, boolean modifier, int selStart, int selEnd, boolean shift, String value, boolean willCommit)
          Return a new "Field/Keystroke" event
static JSEvent createFieldMouseDown(WidgetAnnotation annot, boolean modifier, boolean shift)
          Return a new "Field/Mouse Down" event
static JSEvent createFieldMouseEnter(WidgetAnnotation annot, boolean modifier, boolean shift)
          Return a new "Field/Mouse Enter" event
static JSEvent createFieldMouseExit(WidgetAnnotation annot, boolean modifier, boolean shift)
          Return a new "Field/Mouse Exit" event
static JSEvent createFieldMouseUp(WidgetAnnotation annot, boolean modifier, boolean shift)
          Return a new "Field/Mouse Up" event
static JSEvent createFieldValidate(WidgetAnnotation annot, String value, boolean shift, boolean modifier, String change, String changeEx, boolean keyDown)
          Return a new "Field/Validate" event
static JSEvent createLinkMouseUp(AnnotationLink annot)
          Return a new "Link/Mouse Up" event
static JSEvent createPageClose(PDFPage page)
          Return a new "Page/Close" event
static JSEvent createPageOpen(PDFPage page)
          Return a new "Page/Open" event
 String getChange()
          Return the "change" attribute of the event object
 String getChangeEx()
          Return the "changeEx" attribute of the event object
 int getCommitKey()
          Return the "commitKey" attribute of the event object
 boolean getFieldFull()
          Return the "fieldFull" attribute of the event object
 boolean getKeyDown()
          Return the "keyDown" attribute of the event object
 boolean getModifier()
          Return the "modifier" attribute of the event object
 String getName()
          Return the "name" attribute of the event object
 boolean getRc()
          Return the "rc" attribute of the event object
 int getSelEnd()
          Return the "selEnd" attribute of the event object
 int getSelStart()
          Return the "selStart" attribute of the event object
 boolean getShift()
          Return the "shift" attribute of the event object
 Object getSource()
          Return the "source" attribute of the event object
 Object getTarget()
          Return the "target" attribute of the event object
 String getTargetName()
          Return the "targetName" attribute of the event object
 String getType()
          Return the "type" attribute of the event object
 String getValue()
          Return the "value" attribute of the event object
 boolean getWillCommit()
          Return the "willCommit" attribute of the event object
 PDFAction javaGetAction()
          Return the PDFAction to be run by the event object
 PDF javaGetPDF()
          Return the PDF this event was raised on, or null if no PDF applies
 void setChange(String value)
          Set the "change" attribute of the event object
 void setRc(boolean rc)
          Set the "rc" attribute of the event object
 void setSelEnd(int value)
          Set the "selEnd" attribute of the event object (only for Field/Keystroke)
 void setSelStart(int value)
          Set the "selState" attribute of the event object
 void setValue(String value)
          Set the "value" attribute of the event object
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getChange

public String getChange()
Return the "change" attribute of the event object


getChangeEx

public String getChangeEx()
Return the "changeEx" attribute of the event object


getCommitKey

public int getCommitKey()
Return the "commitKey" attribute of the event object


getFieldFull

public boolean getFieldFull()
Return the "fieldFull" attribute of the event object


getKeyDown

public boolean getKeyDown()
Return the "keyDown" attribute of the event object


getModifier

public boolean getModifier()
Return the "modifier" attribute of the event object


getName

public String getName()
Return the "name" attribute of the event object


getRc

public boolean getRc()
Return the "rc" attribute of the event object


getSelStart

public int getSelStart()
Return the "selStart" attribute of the event object


getSelEnd

public int getSelEnd()
Return the "selEnd" attribute of the event object


getShift

public boolean getShift()
Return the "shift" attribute of the event object


getSource

public Object getSource()
Return the "source" attribute of the event object


getTarget

public Object getTarget()
Return the "target" attribute of the event object


getTargetName

public String getTargetName()
Return the "targetName" attribute of the event object


getType

public String getType()
Return the "type" attribute of the event object


getValue

public String getValue()
Return the "value" attribute of the event object


getWillCommit

public boolean getWillCommit()
Return the "willCommit" attribute of the event object


javaGetAction

public PDFAction javaGetAction()
Return the PDFAction to be run by the event object


javaGetPDF

public PDF javaGetPDF()
Return the PDF this event was raised on, or null if no PDF applies


setValue

public void setValue(String value)
Set the "value" attribute of the event object


setChange

public void setChange(String value)
Set the "change" attribute of the event object


setSelStart

public void setSelStart(int value)
Set the "selState" attribute of the event object


setSelEnd

public void setSelEnd(int value)
Set the "selEnd" attribute of the event object (only for Field/Keystroke)


setRc

public void setRc(boolean rc)
Set the "rc" attribute of the event object


toString

public String toString()
Overrides:
toString in class Object

createAppInit

public static JSEvent createAppInit()
Return a new "App/Init" event


createBatchExec

public static JSEvent createBatchExec(PDF pdf,
                                      String javascript)
Return a new "Batch/Exec" event

Parameters:
pdf - the PDF the JavaScript is being run on
javascript - the JavaScript being run

createBookmarkMouseUp

public static JSEvent createBookmarkMouseUp(PDFBookmark bookmark)
Return a new "Bookmark/Mouse Up" event

Parameters:
bookmark - the Bookmark

createConsoleExec

public static JSEvent createConsoleExec(PDF pdf,
                                        String javascript)
Return a new "Console/Exec" event

Parameters:
javascript - the JavaScript being run

createDocDidPrint

public static JSEvent createDocDidPrint(PDF pdf)
Return a new "Doc/DidPrint" event

Parameters:
pdf - the PDF

createDocDidSave

public static JSEvent createDocDidSave(PDF pdf)
Return a new "Doc/DidSave" event

Parameters:
pdf - the PDF

createDocOpen

public static JSEvent createDocOpen(PDF pdf,
                                    String targetName)
Return a new "Doc/Open" event

Parameters:
pdf - the PDF
targetName - the name of the PDF file.

createDocWillClose

public static JSEvent createDocWillClose(PDF pdf)
Return a new "Doc/WillClose" event

Parameters:
pdf - the PDF

createDocWillPrint

public static JSEvent createDocWillPrint(PDF pdf)
Return a new "Doc/WillPrint" event

Parameters:
pdf - the PDF

createDocWillSave

public static JSEvent createDocWillSave(PDF pdf)
Return a new "Doc/WillSave" event

Parameters:
pdf - the PDF

createExternalExec

public static JSEvent createExternalExec(String javascript)
Return a new "External/Exec" event

Parameters:
javascript - the JavaScript being run

createFieldBlur

public static JSEvent createFieldBlur(WidgetAnnotation annot,
                                      boolean shift,
                                      boolean modifier)
Return a new "Field/Blur" event

Parameters:
annot - the Widget
shift - the shift property
modifier - the modifier property

createFieldCalculate

public static JSEvent createFieldCalculate(WidgetAnnotation target,
                                           WidgetAnnotation source)
Return a new "Field/Calculate" event

Parameters:
target - the target Widget
source - the source Widget

createFieldFocus

public static JSEvent createFieldFocus(WidgetAnnotation annot,
                                       boolean shift,
                                       boolean modifier)
Return a new "Field/Focus" event

Parameters:
annot - the Widget
shift - the shift property
modifier - the modifier property

createFieldFormat

public static JSEvent createFieldFormat(WidgetAnnotation annot,
                                        int commitKey,
                                        boolean willCommit)
Return a new "Field/Format" event

Parameters:
annot - the Widget
commitKey - the commitKey property
willCommit - the willCommit property

createFieldKeystroke

public static JSEvent createFieldKeystroke(WidgetAnnotation annot,
                                           int commitKey,
                                           String change,
                                           String changeEx,
                                           boolean fieldFull,
                                           boolean keyDown,
                                           boolean modifier,
                                           int selStart,
                                           int selEnd,
                                           boolean shift,
                                           String value,
                                           boolean willCommit)
Return a new "Field/Keystroke" event

Parameters:
annot - the Widget
commitKey - the commitKey property
change - the change property
changeEx - the changeEx property
fieldFull - the fieldFull property
keyDown - the keyDown property
modifier - the modifier property
selStart - the selStart property
selEnd - the selEnd property
shift - the shift property
value - the value property
willCommit - the willCommit property

createFieldMouseDown

public static JSEvent createFieldMouseDown(WidgetAnnotation annot,
                                           boolean modifier,
                                           boolean shift)
Return a new "Field/Mouse Down" event

Parameters:
annot - the Widget
modifier - the modifier property
shift - the shift property

createFieldMouseEnter

public static JSEvent createFieldMouseEnter(WidgetAnnotation annot,
                                            boolean modifier,
                                            boolean shift)
Return a new "Field/Mouse Enter" event

Parameters:
annot - the Widget
modifier - the modifier property
shift - the shift property

createFieldMouseExit

public static JSEvent createFieldMouseExit(WidgetAnnotation annot,
                                           boolean modifier,
                                           boolean shift)
Return a new "Field/Mouse Exit" event

Parameters:
annot - the Widget
modifier - the modifier property
shift - the shift property

createFieldMouseUp

public static JSEvent createFieldMouseUp(WidgetAnnotation annot,
                                         boolean modifier,
                                         boolean shift)
Return a new "Field/Mouse Up" event

Parameters:
annot - the Widget
modifier - the modifier property
shift - the shift property

createFieldValidate

public static JSEvent createFieldValidate(WidgetAnnotation annot,
                                          String value,
                                          boolean shift,
                                          boolean modifier,
                                          String change,
                                          String changeEx,
                                          boolean keyDown)
Return a new "Field/Validate" event

Parameters:
annot - the Widget
value - the value property
shift - the shift property
modifier - the modifier property
change - the change property
changeEx - the changeEx property
keyDown - the keyDown property

createLinkMouseUp

public static JSEvent createLinkMouseUp(AnnotationLink annot)
Return a new "Link/Mouse Up" event

Parameters:
annot - the link object

createPageOpen

public static JSEvent createPageOpen(PDFPage page)
Return a new "Page/Open" event

Parameters:
page - the page

createPageClose

public static JSEvent createPageClose(PDFPage page)
Return a new "Page/Close" event

Parameters:
page - the page


Copyright © 2001-2012 Big Faceless Organization