it.stefanochizzolini.clown.documents.interaction.navigation.document
Class Destination

java.lang.Object
  it.stefanochizzolini.clown.objects.PdfObjectWrapper<TDataObject>
      it.stefanochizzolini.clown.objects.PdfNamedObjectWrapper<PdfArray>
          it.stefanochizzolini.clown.documents.interaction.navigation.document.Destination

Direct Known Subclasses:

LocalDestination, RemoteDestination

public abstract class Destination
extends PdfNamedObjectWrapper<PdfArray>

Interaction target [PDF:1.6:8.2.1].

Remarks

It represents a particular view of a document, consisting of the following items:

• the page of the document to be displayed;
• the location of the document window on that page;
• the magnification (zoom) factor to use when displaying the page.

Version:

0.0.8

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Nested Class Summary

static class

Destination.ModeEnum Destination mode [PDF:1.6:8.2.1].

Constructor Summary

protected	Destination(Document context, PdfDirectObject pageObject, Destination.ModeEnum mode, Double[] viewParams) Creates a new destination within the given document context.
protected	Destination(PdfDirectObject baseObject, PdfIndirectObject container, PdfString name)

Method Summary

Destination	clone(Document context) Gets a clone of the object, registered inside the given document context.
Destination.ModeEnum	getMode() Gets the destination mode.
abstract Object	getPageRef() Gets the target page reference.
static Destination	wrap(PdfDirectObject baseObject, PdfIndirectObject container, PdfString name) Wraps a destination base object into a destination object.

Methods inherited from class it.stefanochizzolini.clown.objects.PdfNamedObjectWrapper

getName, getNamedBaseObject

Methods inherited from class it.stefanochizzolini.clown.objects.PdfObjectWrapper

delete, getBaseDataObject, getBaseObject, getContainer, getDocument, getFile, setBaseObject, setContainer, update

Methods inherited from class java.lang.Object

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

Constructor Detail

Destination

protected Destination(Document context,
                      PdfDirectObject pageObject,
                      Destination.ModeEnum mode,
                      Double[] viewParams)

Creates a new destination within the given document context.

Parameters:

context - Document context.

pageObject - Page reference. It may be either an actual page reference (PdfReference) or a page index (PdfInteger).

mode - Destination mode.

viewParams - View parameters. Their actual composition depends on the mode value (see ModeEnum for more info).

Destination

protected Destination(PdfDirectObject baseObject,
                      PdfIndirectObject container,
                      PdfString name)

Method Detail

wrap

public static final Destination wrap(PdfDirectObject baseObject,
                                     PdfIndirectObject container,
                                     PdfString name)

Wraps a destination base object into a destination object.

Parameters:

baseObject - Destination base object.

container - Destination base object container.

name - Destination name.

Returns:

Destination object associated to the base object.

clone

public Destination clone(Document context)

Description copied from class: PdfObjectWrapper

Gets a clone of the object, registered inside the given document context.

Specified by:

clone in class PdfObjectWrapper<PdfArray>

Parameters:

context - Which document the clone has to be registered in.

getMode

public Destination.ModeEnum getMode()

Gets the destination mode.

getPageRef

public abstract Object getPageRef()

Gets the target page reference.