com.crionics.jpdf.action
Class HideAction

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

public class HideAction
extends AbstractAction

A Hide action allows to hide or to make visible annotations or form fields.

Method Summary

static HideAction	createInstance(PdfDocument doc) Allows the creation of a new Action into the Specified document.
java.util.List	getObjects() Recovers the Annotations and Form Fields which are affected by this action.
boolean	isHiding() Query the hiding status of this action.
void	setHiding(boolean flag) Sets the hiding flag of the Action.
void	setObjects(java.util.List list) Sets the the Annotations and Form Fields to be affected 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 HideAction 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.

getObjects

public java.util.List getObjects()
                          throws PdfException,
                                 java.io.IOException

Recovers the Annotations and Form Fields which are affected by this action.

Returns:

A List containing objects with the base type AbstractAnnotation or AbstractField or null if none are present.

Throws:

PdfException - If a problem occured while parsing the document.

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

isHiding

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

Query the hiding status of this action.

Returns:

true if the Form Fields registered in this action will be hidden, false otherwise.

Throws:

PdfException - If a problem occured while parsing the document.

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

setHiding

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

Sets the hiding flag of the Action.

Parameters:

flag - true if the Form Field should be hidden, false if they should be made visible.

Throws:

PdfException - If a problem occured while parsing the document.

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

setObjects

public void setObjects(java.util.List list)
                throws PdfException,
                       java.io.IOException

Sets the the Annotations and Form Fields to be affected by this Action.

Parameters:

list - This list must contain only objects with the base type AbstractAnnotation or AbstractField. If list is set to null all the currenlty registered object in this action will be unregistered.

Throws:

PdfException - If a problem occured while parsing the document.

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