com.adobe.xfa
Class ScriptHandler

java.lang.Object
  com.adobe.xfa.ScriptHandler

Direct Known Subclasses:

FormCalcScriptHandler, RhinoScriptHandler

public abstract class ScriptHandler
extends java.lang.Object

A base class to handle scripting engines. A script handler is used by an XFA application model to enable scripting support. A script handler provides support for one particular language.

Field Summary

static int	ACTIVITY_CHANGE The activity change reason.
static int	ACTIVITY_CLICK The activity click reason.
static int	ACTIVITY_DOCCLOSE The activity do close reason.
static int	ACTIVITY_DOCREADY The activity doc ready reason.
static int	ACTIVITY_ENTER The activity enter reason.
static int	ACTIVITY_EXIT The activity exit reason.
static int	ACTIVITY_FULL The activity full reason.
static int	ACTIVITY_INDEXCHANGE The activity index change reason.
static int	ACTIVITY_INITIALIZE An activity initialize script reason.
static int	ACTIVITY_MOUSEDOWN The activity mouse down reason.
static int	ACTIVITY_MOUSEENTER The activity mouse enter reason.
static int	ACTIVITY_MOUSEEXIT The activity mouse exit reason.
static int	ACTIVITY_MOUSEUP The activity mouse up reason.
static int	ACTIVITY_POSTEXECUTE The activity post-execute reason.
static int	ACTIVITY_POSTOPEN The activity post-open reason.
static int	ACTIVITY_POSTPRINT The activity post-print reason.
static int	ACTIVITY_POSTSAVE The activity post-save reason.
static int	ACTIVITY_POSTSIGN The activity post-sign reason.
static int	ACTIVITY_POSTSUBMIT The activity post-submit reason.
static int	ACTIVITY_PREEXECUTE The activity pre-execute reason.
static int	ACTIVITY_PREOPEN The activity pre-open reason.
static int	ACTIVITY_PREPRINT The activity pre-print reason.
static int	ACTIVITY_PRESAVE An activity pre-save script reason.
static int	ACTIVITY_PRESIGN The activity pre-sign reason.
static int	ACTIVITY_PRESUBMIT The activity pre-submit reason.
static int	ACTIVITY_READY The activity ready reason.
static int	ACTIVITY_VALIDATIONSTATE The activity validation state reason.
static int	CALCULATE The calculate script reason.
static int	PREDICATE The predicate (when executing a predicate in a SOM expression) reason.
static int	UNSPECIFIED The unspecified script reason.
static int	VALIDATE The validate script reason.

Constructor Summary

ScriptHandler()
Instantiates a script handler.

Method Summary

abstract ScriptHandler	clone() Clones this script handler.
void	execute(java.lang.String script, java.lang.String locale, Arg returnValue, int eReason) Executes the given script.
abstract java.lang.String	languageName() Gets the name of the scripting language supported by this script handler.

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED

public static final int UNSPECIFIED

The unspecified script reason.

See Also:

Constant Field Values

CALCULATE

public static final int CALCULATE

The calculate script reason.

See Also:

Constant Field Values

VALIDATE

public static final int VALIDATE

The validate script reason.

See Also:

Constant Field Values

ACTIVITY_INITIALIZE

public static final int ACTIVITY_INITIALIZE

An activity initialize script reason.

See Also:

Constant Field Values

ACTIVITY_PRESAVE

public static final int ACTIVITY_PRESAVE

An activity pre-save script reason.

See Also:

Constant Field Values

ACTIVITY_POSTSAVE

public static final int ACTIVITY_POSTSAVE

The activity post-save reason.

See Also:

Constant Field Values

ACTIVITY_PREPRINT

public static final int ACTIVITY_PREPRINT

The activity pre-print reason.

See Also:

Constant Field Values

ACTIVITY_POSTPRINT

public static final int ACTIVITY_POSTPRINT

The activity post-print reason.

See Also:

Constant Field Values

ACTIVITY_READY

public static final int ACTIVITY_READY

The activity ready reason.

See Also:

Constant Field Values

ACTIVITY_DOCREADY

public static final int ACTIVITY_DOCREADY

The activity doc ready reason.

See Also:

Constant Field Values

ACTIVITY_DOCCLOSE

public static final int ACTIVITY_DOCCLOSE

The activity do close reason.

See Also:

Constant Field Values

ACTIVITY_PRESUBMIT

public static final int ACTIVITY_PRESUBMIT

The activity pre-submit reason.

See Also:

Constant Field Values

ACTIVITY_PREEXECUTE

public static final int ACTIVITY_PREEXECUTE

The activity pre-execute reason.

See Also:

Constant Field Values

ACTIVITY_POSTEXECUTE

public static final int ACTIVITY_POSTEXECUTE

The activity post-execute reason.

See Also:

Constant Field Values

ACTIVITY_PREOPEN

public static final int ACTIVITY_PREOPEN

The activity pre-open reason.

See Also:

Constant Field Values

ACTIVITY_INDEXCHANGE

public static final int ACTIVITY_INDEXCHANGE

The activity index change reason.

See Also:

Constant Field Values

PREDICATE

public static final int PREDICATE

The predicate (when executing a predicate in a SOM expression) reason.

See Also:

Constant Field Values

ACTIVITY_PRESIGN

public static final int ACTIVITY_PRESIGN

The activity pre-sign reason.

See Also:

Constant Field Values

ACTIVITY_POSTSIGN

public static final int ACTIVITY_POSTSIGN

The activity post-sign reason.

See Also:

Constant Field Values

ACTIVITY_POSTSUBMIT

public static final int ACTIVITY_POSTSUBMIT

The activity post-submit reason.

See Also:

Constant Field Values

ACTIVITY_POSTOPEN

public static final int ACTIVITY_POSTOPEN

The activity post-open reason.

See Also:

Constant Field Values

ACTIVITY_VALIDATIONSTATE

public static final int ACTIVITY_VALIDATIONSTATE

The activity validation state reason.

See Also:

Constant Field Values

ACTIVITY_ENTER

public static final int ACTIVITY_ENTER

The activity enter reason.

See Also:

Constant Field Values

ACTIVITY_EXIT

public static final int ACTIVITY_EXIT

The activity exit reason.

See Also:

Constant Field Values

ACTIVITY_MOUSEENTER

public static final int ACTIVITY_MOUSEENTER

The activity mouse enter reason.

See Also:

Constant Field Values

ACTIVITY_MOUSEEXIT

public static final int ACTIVITY_MOUSEEXIT

The activity mouse exit reason.

See Also:

Constant Field Values

ACTIVITY_CHANGE

public static final int ACTIVITY_CHANGE

The activity change reason.

See Also:

Constant Field Values

ACTIVITY_CLICK

public static final int ACTIVITY_CLICK

The activity click reason.

See Also:

Constant Field Values

ACTIVITY_FULL

public static final int ACTIVITY_FULL

The activity full reason.

See Also:

Constant Field Values

ACTIVITY_MOUSEUP

public static final int ACTIVITY_MOUSEUP

The activity mouse up reason.

See Also:

Constant Field Values

ACTIVITY_MOUSEDOWN

public static final int ACTIVITY_MOUSEDOWN

The activity mouse down reason.

See Also:

Constant Field Values

Constructor Detail

ScriptHandler

public ScriptHandler()

Instantiates a script handler.

Method Detail

execute

public void execute(java.lang.String script,
                    java.lang.String locale,
                    Arg returnValue,
                    int eReason)

Executes the given script.

Parameters:

script - the script to execute.

locale - the operating locale.

returnValue - the return value of the script.

eReason - the reason for the execution of the script.

Throws:

ExFull - whenever errors are reported.

languageName

public abstract java.lang.String languageName()

Gets the name of the scripting language supported by this script handler.

Returns:

the name of the scripting language.

clone

public abstract ScriptHandler clone()

Clones this script handler.

Overrides:

clone in class java.lang.Object

Returns:

a copy of this script handler.