com.crionics.jpdf.action
Class ResetFormAction

java.lang.Object
  PdfObjectContainer
      com.crionics.jpdf.action.AbstractAction
          com.crionics.jpdf.action.ResetFormAction

public class ResetFormAction
extends AbstractAction

A Reset Form action resets selected interactive form fields to their default values. If no default value is defined for a field, its value is simply removed. For fields that can have no value (such as pushbuttons), the action has no effect.

Method Summary

static ResetFormAction	createInstance(PdfDocument doc) Allows the creation of a new Action into the Specified document.
AbstractField[]	getFields() Recovers the Form Fields which will be affected or not (see isExcluding()) by this action.
boolean	isExcluding() Determines if the Form Fields references in this action will be affected by this action or not.
void	setExcluding(boolean flag) Sets the status of the Form Fields references in this action.
void	setFields(AbstractField[] fields) Sets the Form Fields which will be affected or not (see isExcluding()and setExcluding(boolean)) by this action.
void	setFields(java.lang.String[] fieldNames) Sets the Form Fields which will be affected or not (see isExcluding()and setExcluding(boolean)) by this action.

Methods inherited from class com.crionics.jpdf.action.AbstractAction

getNextAction, hasNextAction, setNextAction

Methods inherited from class java.lang.Object

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

Method Detail

createInstance

public static ResetFormAction createInstance(PdfDocument doc)
                                      throws PdfException,
                                             java.io.IOException

Allows the creation of a new Action into the Specified document.

The usage of this method requires the acquision of the Module jPDF Creator or jPDF Template

Parameters:

doc - The Document into which the Action should be created.

Returns:

The action created.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.

getFields

public AbstractField[] getFields()
                          throws PdfException,
                                 java.io.IOException

Recovers the Form Fields which will be affected or not (see isExcluding()) by this action.

Returns:

An array of the fields affected by this action, or null if all the Form Fields present in the PDF document will be affected by this action.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.

isExcluding

public boolean isExcluding()
                    throws java.io.IOException,
                           PdfException

Determines if the Form Fields references in this action will be affected by this action or not.

Returns:

true if all the Form Fields present in the document but the ones referenced in this action (see the method getFields()) will be affected by the action, or false if only the ones referenced will be.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.

setExcluding

public void setExcluding(boolean flag)
                  throws java.io.IOException,
                         PdfException

Sets the status of the Form Fields references in this action.

Parameters:

flag - Sets this value to true if all the Form Fields present in the document but the ones referenced in this action (see the method getFields()) should be affected by the action, or false if only the ones referenced must be.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.

setFields

public void setFields(AbstractField[] fields)
               throws PdfException,
                      java.io.IOException

Sets the Form Fields which will be affected or not (see isExcluding()and setExcluding(boolean)) by this action.

Parameters:

fields - The Form Fields to be affected by this action, or null to affect all the Form Fields present in the document.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.

setFields

public void setFields(java.lang.String[] fieldNames)
               throws PdfException,
                      java.io.IOException

Sets the Form Fields which will be affected or not (see isExcluding()and setExcluding(boolean)) by this action.

Parameters:

fieldNames - The name of the Form Fields to be affected by this action, or null to affect all the Form Fields present in the document.

Throws:

PdfException - If a problem occured while parsing the document.

java.io.IOException - If a problem occured while parsing the file.