org.icepdf.core.pobjects.actions
Class GoToAction

java.lang.Object
  extended by org.icepdf.core.pobjects.Dictionary
      extended by org.icepdf.core.pobjects.actions.Action
          extended by org.icepdf.core.pobjects.actions.GoToAction

public class GoToAction
extends Action

The class GoToAction represents the Action type "GoTo". It's purpose when called to to navigate the a destination in the document specified by this action.

Since:
2.6
Author:
ICEsoft Technologies, Inc.

Field Summary
static Name DESTINATION_KEY
           
 
Fields inherited from class org.icepdf.core.pobjects.actions.Action
ACTION_TYPE, ACTION_TYPE_GOTO, ACTION_TYPE_GOTO_REMOTE, ACTION_TYPE_KEY, ACTION_TYPE_LAUNCH, ACTION_TYPE_URI, NEXT_KEY
 
Fields inherited from class org.icepdf.core.pobjects.Dictionary
entries, inited, isDeleted, isNew, library, SUBTYPE_KEY, TYPE_KEY
 
Constructor Summary
GoToAction(Library l, java.util.Hashtable h)
          Creates a new instance of a GoTo Action.
 
Method Summary
 Destination getDestination()
          Gets the Destination object which the "GoTo" action should jump to.
 void setDestination(Destination destination)
          Set the destination and adds the new data to the action's dictionary
 
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, 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

DESTINATION_KEY

public static final Name DESTINATION_KEY
Constructor Detail

GoToAction

public GoToAction(Library l,
                  java.util.Hashtable h)
Creates a new instance of a GoTo Action.

Parameters:
l - document library.
h - Action dictionary entries.
Method Detail

setDestination

public void setDestination(Destination destination)
Set the destination and adds the new data to the action's dictionary

Parameters:
destination - new destionat, replace old values.

getDestination

public Destination getDestination()
Gets the Destination object which the "GoTo" action should jump to.

Returns:
Destination object specified in the action.