org.icepdf.core.pobjects.actions

Class ResetFormAction

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.actions.Action

org.icepdf.core.pobjects.actions.FormAction

org.icepdf.core.pobjects.actions.ResetFormAction

public class ResetFormAction
extends FormAction

Upon invocation of a reset-form action, a conforming processor shall reset selected interactive form fields to their default values; that is, it shall set the value of the V entry in the field dictionary to that of the DV entry. If no default value is defined for a field, its V entry shall be removed. For fields that can have no value (such as pushButtons), the action has no effect. Table 238 shows the action dictionary entries specific to this type of action.

The value of the action dictionary’s Flags entry is a non-negative containing flags specifying various characteristics of the action. Bit positions within the flag word shall be numbered starting from 1 (low-order). Only one flag is defined for this type of action. All undefined flag bits shall be reserved and shall be set to 0.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
int	INCLUDE_EXCLUDE_BIT If clear, the Fields array specifies which fields to reset.

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

F_KEY, FIELDS_KEY, FLAGS_KEY

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
ResetFormAction(Library l, java.util.HashMap h)

Method Summary

Modifier and Type	Method and Description
protected void	descendFormTree(java.lang.Object formNode) Recursively reset all the form fields.
int	executeFormAction(int x, int y) Upon invocation of a reset-form action, a conforming processor shall reset selected interactive form fields to their default values; that is, it shall set the value of the V entry in the field dictionary to that of the DV entry.
boolean	isIncludeExclude()

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

getFlags

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

INCLUDE_EXCLUDE_BIT

public int INCLUDE_EXCLUDE_BIT

If clear, the Fields array specifies which fields to reset. (All descendants of the specified fields in the field hierarchy are reset as well.) If set, the Fields array indicates which fields to exclude from resetting; that is, all fields in the document’s interactive form shall be reset except those listed in the Fields array.

Constructor Detail

ResetFormAction

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

Method Detail

executeFormAction

public int executeFormAction(int x,
                             int y)

Upon invocation of a reset-form action, a conforming processor shall reset selected interactive form fields to their default values; that is, it shall set the value of the V entry in the field dictionary to that of the DV entry. If no default value is defined for a field, its V entry shall be removed. For fields that can have no value (such as pushButtons), the action has no effect. Table 238 shows the action dictionary entries specific to this type of action.

Specified by:

executeFormAction in class FormAction

Parameters:

x - x-coordinate of the mouse event that actuated the submit.

y - y-coordinate of the mouse event that actuated the submit.

Returns:

value of one if reset was successful, zero if not.

descendFormTree

protected void descendFormTree(java.lang.Object formNode)

Recursively reset all the form fields.

Parameters:

formNode - root form node.

isIncludeExclude

public boolean isIncludeExclude()

See Also:

INCLUDE_EXCLUDE_BIT