com.icesoft.pdf.pobjects.actions
Class Action

java.lang.Object
  com.icesoft.pdf.pobjects.Dictionary
      com.icesoft.pdf.pobjects.actions.Action

Direct Known Subclasses:

GoToAction, GoToRAction, LaunchAction, URIAction

public class Action

extends Dictionary

The Action class represents an Action Dictionary which defines characteristics and behavior of an action. A PDF action can be a wide variety of standard action types. This class is designed to help users get needed attributes from the Action Dictionary. The Dictionary classes getEntries method can be used to find other attributes associated with this action.

ICEpdf currently only uses the "GoTo" action when working with document outlines. If your application is interpreting a page's Annotations then you can query the Annotation object to get its Action.

Since:

1.0

Field Summary

static String	ACTION_TYPE_GOTO
static String	ACTION_TYPE_GOTO_REMOTE
static String	ACTION_TYPE_LAUNCH
static String	ACTION_TYPE_URI

Fields inherited from class com.icesoft.pdf.pobjects.Dictionary

entries, inited, library

Constructor Summary

Action(Library l, Hashtable h)
Creates a new instance of a Action.

Method Summary

String

getType() Gets the type of action that this dictionary describes.

Methods inherited from class com.icesoft.pdf.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ACTION_TYPE_GOTO

public static final String ACTION_TYPE_GOTO

See Also:

Constant Field Values

ACTION_TYPE_GOTO_REMOTE

public static final String ACTION_TYPE_GOTO_REMOTE

See Also:

Constant Field Values

ACTION_TYPE_LAUNCH

public static final String ACTION_TYPE_LAUNCH

See Also:

Constant Field Values

ACTION_TYPE_URI

public static final String ACTION_TYPE_URI

See Also:

Constant Field Values

Constructor Detail

Action

public Action(Library l,
              Hashtable h)

Creates a new instance of a Action.

Parameters:

l - document library.

h - Action dictionary entries.

Method Detail

getType

public String getType()

Gets the type of action that this dictionary describes. The most common actions can be found in the PDF Reference 1.6 in section 8.5.3. ICEpdf currently only takes advantage of the "GoTo" action when a user clicks on a document outline.

Returns:

The action type.