de.intarsys.pdf.pd
Class PDExplicitDestination

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDDestination
              de.intarsys.pdf.pd.PDExplicitDestination

All Implemented Interfaces:

ICOSObjectListener, IAttributeSupport

public class PDExplicitDestination
extends PDDestination

The explicit reference to a destination in a PDF document, consisting of a page and a definition of the rectangle to be displayed.

Nested Class Summary

static class

PDExplicitDestination.MetaClass The meta class implementation

Field Summary

static COSName	CN_DISPLAY_MODE_Fit
static COSName	CN_DISPLAY_MODE_FitB
static COSName	CN_DISPLAY_MODE_FitBH
static COSName	CN_DISPLAY_MODE_FitBV
static COSName	CN_DISPLAY_MODE_FitH
static COSName	CN_DISPLAY_MODE_FitR
static COSName	CN_DISPLAY_MODE_FitV
static COSName	CN_DISPLAY_MODE_XYZ
static PDExplicitDestination.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Method Summary

COSName	getDisplayMode()
PDPage	getPage(PDDocument doc) The destination page.
float[]	getParameters()
PDExplicitDestination	getResolvedDestination(PDDocument doc)
void	setDisplayMode(COSName mode)
void	setPage(PDPage page)
void	setParameters(double[] parameters)
void	setParameters(float[] parameters)

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent, toString

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, invalidateCaches, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

META

public static final PDExplicitDestination.MetaClass META

The meta class instance

CN_DISPLAY_MODE_XYZ

public static final COSName CN_DISPLAY_MODE_XYZ

CN_DISPLAY_MODE_Fit

public static final COSName CN_DISPLAY_MODE_Fit

CN_DISPLAY_MODE_FitH

public static final COSName CN_DISPLAY_MODE_FitH

CN_DISPLAY_MODE_FitV

public static final COSName CN_DISPLAY_MODE_FitV

CN_DISPLAY_MODE_FitR

public static final COSName CN_DISPLAY_MODE_FitR

CN_DISPLAY_MODE_FitB

public static final COSName CN_DISPLAY_MODE_FitB

CN_DISPLAY_MODE_FitBH

public static final COSName CN_DISPLAY_MODE_FitBH

CN_DISPLAY_MODE_FitBV

public static final COSName CN_DISPLAY_MODE_FitBV

Method Detail

getDisplayMode

public COSName getDisplayMode()

getPage

public PDPage getPage(PDDocument doc)

The destination page. ATTENTION: it is common have dangling destinations to invalid (null) pages around!

Returns:

The destination page. Be sure to handle null return values.

setPage

public void setPage(PDPage page)

setDisplayMode

public void setDisplayMode(COSName mode)

getParameters

public float[] getParameters()

setParameters

public void setParameters(float[] parameters)

setParameters

public void setParameters(double[] parameters)

getResolvedDestination

public PDExplicitDestination getResolvedDestination(PDDocument doc)

Specified by:

getResolvedDestination in class PDDestination