GoToAction Class Documentation

class GoToAction : Action

Namespace:com::datalogics::PDFL

Inherits from:
Action

Detailed Description

A go-to action can be executed in a PDF document. A go-to action includes a hyperlink that, when clicked, takes the reader to a different place within the same document.

The action is linked to a bookmark within the document.

A remote go-to action includes a hyperlink that takes the reader to a destination in a separate document.

Constructor & Destructor Documentation

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

equals

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

finalize

void finalize()

Returns:

void

getDestination

ViewDestination getDestination()

Returns:

ViewDestination

The ViewDestination for this action.

The ViewDestination that this go-to action navigates to.

getPDFDict

PDFDict getPDFDict()

Returns:

PDFDict

The underlying PDF dictionary for this Action.

Retrieve the PDFObject representation of this object.

getSubtype

String getSubtype()

Returns:

String

The subtype string for this action, such as "GoTo", "URI", "Launch", or "GoToR".

The action's subtype.

setDestination

void setDestination(ViewDestination dest)

Parameters

dest: ViewDestination

The ViewDestination to set, or null to remove.

Returns:

void

The ViewDestination that this go-to action navigates to. Setting the destination to null removes the destination entry from the action dictionary.

toString

String toString()

Returns:

String

A string describing this Action.

Returns a string representation of this Action. The string includes the action's subtype.