org.icepdf.core.pobjects.actions

Class FormAction

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.actions.Action

org.icepdf.core.pobjects.actions.FormAction

Direct Known Subclasses:

ResetFormAction, SubmitFormAction

public abstract class FormAction
extends Action

Execute interface for Form actions.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
static Name	F_KEY (Required) A URL file specification (see 7.11.5, "URL Specifications") giving the uniform resource locator (URL) of the script at the Web server that will process the submission.
static Name	FIELDS_KEY An array identifying which fields to reset or which to exclude from resetting, depending on the setting of the Include/Exclude flag in the Flags entry (see Table 239).
static Name	FLAGS_KEY (Optional; inheritable) A set of flags specifying various characteristics of the action (see Table 239).

Fields inherited from class org.icepdf.core.pobjects.actions.Action

ACTION_TYPE, ACTION_TYPE_GOTO, ACTION_TYPE_GOTO_REMOTE, ACTION_TYPE_JAVA_SCRIPT, ACTION_TYPE_KEY, ACTION_TYPE_LAUNCH, ACTION_TYPE_NAMED, ACTION_TYPE_RESET_SUBMIT, ACTION_TYPE_SUBMIT_SUBMIT, ACTION_TYPE_URI, NEXT_KEY

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
FormAction(Library l, java.util.HashMap h)

Method Summary

Modifier and Type	Method and Description
abstract int	executeFormAction(int x, int y) Execute the form action and return the appropriate return code;
int	getFlags() (Optional; inheritable) A set of flags specifying various characteristics of the action (see Table 239).

Methods inherited from class org.icepdf.core.pobjects.actions.Action

buildAction, getType, similar

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

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

Field Detail

F_KEY

public static final Name F_KEY

(Required) A URL file specification (see 7.11.5, "URL Specifications") giving the uniform resource locator (URL) of the script at the Web server that will process the submission.

FIELDS_KEY

public static final Name FIELDS_KEY

An array identifying which fields to reset or which to exclude from resetting, depending on the setting of the Include/Exclude flag in the Flags entry (see Table 239). Each element of the array shall be either an indirect reference to a field dictionary or (PDF 1.3) a text string representing the fully qualified name of a field. Elements of both kinds may be mixed in the same array.

If this entry is omitted, the Include/Exclude flag shall be ignored, and all fields in the document’s interactive form shall be submitted except those whose NoExport flag (see Table 221) is set. Fields with no values may also be excluded, as dictated by the value of the IncludeNoValueFields flag; see Table 237.

FLAGS_KEY

public static final Name FLAGS_KEY

(Optional; inheritable) A set of flags specifying various characteristics of the action (see Table 239). Default value: 0.

Constructor Detail

FormAction

public FormAction(Library l,
                  java.util.HashMap h)

Method Detail

getFlags

public int getFlags()

(Optional; inheritable) A set of flags specifying various characteristics of the action (see Table 239). Default value: 0.

Returns:

flag value

executeFormAction

public abstract int executeFormAction(int x,
                                      int y)

Execute the form action and return the appropriate return code;

Returns:

determined by the implementation.