com.itextpdf.kernel.pdf.navigation

Class PdfExplicitDestination

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfObject>

com.itextpdf.kernel.pdf.navigation.PdfDestination

com.itextpdf.kernel.pdf.navigation.PdfExplicitDestination

All Implemented Interfaces:

Serializable

public class PdfExplicitDestination
extends PdfDestination

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfExplicitDestination()
PdfExplicitDestination(PdfArray pdfObject)

Method Summary

Modifier and Type	Method and Description
static PdfExplicitDestination	create(int pageNum, PdfName type, float left, float bottom, float right, float top, float zoom)
static PdfExplicitDestination	create(PdfPage page, PdfName type, float left, float bottom, float right, float top, float zoom)
static PdfExplicitDestination	createFit(int pageNum)
static PdfExplicitDestination	createFit(PdfPage page)
static PdfExplicitDestination	createFitB(int pageNum)
static PdfExplicitDestination	createFitB(PdfPage page)
static PdfExplicitDestination	createFitBH(int pageNum, float top)
static PdfExplicitDestination	createFitBH(PdfPage page, float top)
static PdfExplicitDestination	createFitBV(int pageNum, float left)
static PdfExplicitDestination	createFitBV(PdfPage page, float left)
static PdfExplicitDestination	createFitH(int pageNum, float top)
static PdfExplicitDestination	createFitH(PdfPage page, float top)
static PdfExplicitDestination	createFitR(int pageNum, float left, float bottom, float right, float top)
static PdfExplicitDestination	createFitR(PdfPage page, float left, float bottom, float right, float top)
static PdfExplicitDestination	createFitV(int pageNum, float left)
static PdfExplicitDestination	createFitV(PdfPage page, float left)
static PdfExplicitDestination	createXYZ(int pageNum, float left, float top, float zoom)
static PdfExplicitDestination	createXYZ(PdfPage page, float left, float top, float zoom)
PdfObject	getDestinationPage(Map<String,PdfObject> names)
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
PdfDestination	replaceNamedDestination(Map<Object,PdfObject> names) Deprecated. do not use this method. Will be removed in 7.1

Methods inherited from class com.itextpdf.kernel.pdf.navigation.PdfDestination

makeDestination

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfExplicitDestination

public PdfExplicitDestination()

PdfExplicitDestination

public PdfExplicitDestination(PdfArray pdfObject)

Method Detail

getDestinationPage

public PdfObject getDestinationPage(Map<String,PdfObject> names)

Specified by:

getDestinationPage in class PdfDestination

replaceNamedDestination

@Deprecated
public PdfDestination replaceNamedDestination(Map<Object,PdfObject> names)

Deprecated. do not use this method. Will be removed in 7.1

Specified by:

replaceNamedDestination in class PdfDestination

createXYZ

public static PdfExplicitDestination createXYZ(PdfPage page,
                                               float left,
                                               float top,
                                               float zoom)

createXYZ

public static PdfExplicitDestination createXYZ(int pageNum,
                                               float left,
                                               float top,
                                               float zoom)

createFit

public static PdfExplicitDestination createFit(PdfPage page)

createFit

public static PdfExplicitDestination createFit(int pageNum)

createFitH

public static PdfExplicitDestination createFitH(PdfPage page,
                                                float top)

createFitH

public static PdfExplicitDestination createFitH(int pageNum,
                                                float top)

createFitV

public static PdfExplicitDestination createFitV(PdfPage page,
                                                float left)

createFitV

public static PdfExplicitDestination createFitV(int pageNum,
                                                float left)

createFitR

public static PdfExplicitDestination createFitR(PdfPage page,
                                                float left,
                                                float bottom,
                                                float right,
                                                float top)

createFitR

public static PdfExplicitDestination createFitR(int pageNum,
                                                float left,
                                                float bottom,
                                                float right,
                                                float top)

createFitB

public static PdfExplicitDestination createFitB(PdfPage page)

createFitB

public static PdfExplicitDestination createFitB(int pageNum)

createFitBH

public static PdfExplicitDestination createFitBH(PdfPage page,
                                                 float top)

createFitBH

public static PdfExplicitDestination createFitBH(int pageNum,
                                                 float top)

createFitBV

public static PdfExplicitDestination createFitBV(PdfPage page,
                                                 float left)

createFitBV

public static PdfExplicitDestination createFitBV(int pageNum,
                                                 float left)

create

public static PdfExplicitDestination create(PdfPage page,
                                            PdfName type,
                                            float left,
                                            float bottom,
                                            float right,
                                            float top,
                                            float zoom)

create

public static PdfExplicitDestination create(int pageNum,
                                            PdfName type,
                                            float left,
                                            float bottom,
                                            float right,
                                            float top,
                                            float zoom)

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfObject>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.