org.jpedal.objects.javascript.jsobjects

Class JSEvent

java.lang.Object

org.jpedal.objects.javascript.jsobjects.JSEvent

public class JSEvent
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	change A string specifying the change in value that the user has just typed.
Object	changeEx Contains the export value of the change and is available only during a Field/Keystroke event for list boxes and combo boxes.
int	commitKey Determines how a form field will lose focus.
String	name The name of the current event as a text string.
boolean	rc Used for validation.
Object[]	richChange Specifies the change in value that the user has just typed.
Object[]	richChangeEx This property is only defined for rich text fields.
Object[]	richValue This property mirrors the richValue property of the Field object and the event.value property for each event.
Object	source The Field object that triggered the calculation event.
Object	target The target object that triggered the event.
String	targetName Tries to return the name of the JavaScript being executed.
String	type The type of the current event.
Object	value This property has different meanings for different field events...
boolean	willCommit

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

change

public String change

A string specifying the change in value that the user has just typed. A JavaScript may replace part or all of this string with different characters. The change may take the form of an individual keystroke or a string of characters (for example, if a paste into the field is performed).

changeEx

public Object changeEx

Contains the export value of the change and is available only during a Field/Keystroke event for list boxes and combo boxes.

commitKey

public int commitKey

Determines how a form field will lose focus. Values are: 0 - Value was not committed (for example, escape key was pressed). 1 - Value was committed because of a click outside the field using the mouse. 2 - Value was committed because of pressing the Enter key. 3 - Value was committed by tabbing to a new field.

name

public String name

The name of the current event as a text string. The type and name together uniquely identify the event. Valid names are: Keystroke Mouse Exit Validate WillPrint Focus DidPrint Blur WillSave Format DidSave Calculate Init MouseUp Exec MouseDown Open MouseEnter Close

rc

public boolean rc

Used for validation. Indicates whether a particular event in the event chain should succeed. Set to false to prevent a change from occurring or a value from committing. The default is true.

richChange

public Object[] richChange

Specifies the change in value that the user has just typed. The richChange property is only defined for rich text fields and mirrors the behavior of the event.change property. The value of richChange is an array of Span objects that specify both the text entered into the field and the formatting. Keystrokes are represented as single member arrays, while rich text pasted into a field is represented as an array of arbitrary length.

richChangeEx

public Object[] richChangeEx

This property is only defined for rich text fields. It mirrors the behavior of the event.changeEx property for text fields. Its value is an array of Span objects that specify both the text entered into the field and the formatting. Keystrokes are represented as single member arrays, while rich text pasted into a field is represented as an array of arbitrary length.

richValue

public Object[] richValue

This property mirrors the richValue property of the Field object and the event.value property for each event.

source

public Object source

The Field object that triggered the calculation event. This object is usually different from the target of the event, which is the field that is being calculated.

target

public Object target

The target object that triggered the event. In all mouse, focus, blur, calculate, validate, and format events, it is the Field object that triggered the event. In other events, such as page open and close, it is the Doc or this object.

targetName

public String targetName

Tries to return the name of the JavaScript being executed. Can be used for debugging purposes to help identify the code causing exceptions to be thrown.

Common values of targetName include: The folder-level script file name for App/Init events The document-level script name forDoc/Open events The PDF file name being processed for Batch/Exec events The field name for Field events The menu item name for Menu/Exec events The screen annotation name for Screen events (multimedia events) When an exception is thrown, targetName is reported if there is an identifiable name.

type

public String type

The type of the current event. The type and name together uniquely identify the event. Valid types are: Batch External Console Bookmark App Link Doc Field Page Menu

value

public Object value

This property has different meanings for different field events... See page 384 of the JavaScript for Acrobat API Reference for all the details.

willCommit

public boolean willCommit