com.crionics.jpdf.action
Class GotoAction

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

public class GotoAction
extends AbstractAction

A Goto Action instruct a PDF Viewer application to go to a specified destination.

Method Summary

static GotoAction	createInstance(PdfDocument doc) Allows the creation of a new Action into the Specified document.
LocalPageDestination	getDestination() Returns the destination currently registered with this action.
void	setDestination(LocalPageDestination destination) Sets the destination currently to be registered with 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 GotoAction 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.

getDestination

public LocalPageDestination getDestination()
                                    throws PdfException,
                                           java.io.IOException

Returns the destination currently registered with this action.

Returns:

The destination of object.

Throws:

PdfException - If a problem occured while parsing the document.

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

setDestination

public void setDestination(LocalPageDestination destination)
                    throws PdfException,
                           java.io.IOException

Sets the destination currently to be registered with this action.

Parameters:

destination - The destination object.

Throws:

PdfException - If a problem occured while parsing the document.

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