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

This class shall be used for creation of destinations, associated with outline items, annotations or actions within current document. If you need to create a destination, associated with an object in another PDF (e.g. Remote Go-To actions or Embedded Go-To actions), you should use PdfExplicitRemoteGoToDestination class instead. Note that despite methods with integer value for page parameter are deprecated in this class, Adobe Acrobat handles such destinations correctly, but removes them completely from a PDF, when it is saved as an optimized pdf with the "discard-invalid-links" option. Therefore it is strongly recommended to use methods accepting pdfPage instance, if the destination is inside of the current document.

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) Deprecated. Use PdfExplicitRemoteGoToDestination.create(int, PdfName, float, float, float, float, float) instead.
static PdfExplicitDestination	create(PdfPage page, PdfName type, float left, float bottom, float right, float top, float zoom)
static PdfExplicitDestination	createFit(int pageNum) Deprecated. Use PdfExplicitRemoteGoToDestination.createFit(int) instead.
static PdfExplicitDestination	createFit(PdfPage page)
static PdfExplicitDestination	createFitB(int pageNum) Deprecated. Use PdfExplicitRemoteGoToDestination.createFitB(int) instead.
static PdfExplicitDestination	createFitB(PdfPage page)
static PdfExplicitDestination	createFitBH(int pageNum, float top) Deprecated. Use PdfExplicitRemoteGoToDestination.createFitBH(int, float) instead.
static PdfExplicitDestination	createFitBH(PdfPage page, float top)
static PdfExplicitDestination	createFitBV(int pageNum, float left) Deprecated. Use PdfExplicitRemoteGoToDestination.createFitBV(int, float) instead.
static PdfExplicitDestination	createFitBV(PdfPage page, float left)
static PdfExplicitDestination	createFitH(int pageNum, float top) Deprecated. Use PdfExplicitRemoteGoToDestination.createFitH(int, float) instead.
static PdfExplicitDestination	createFitH(PdfPage page, float top)
static PdfExplicitDestination	createFitR(int pageNum, float left, float bottom, float right, float top) Deprecated. Use PdfExplicitRemoteGoToDestination.createFitR(int, float, float, float, float) instead.
static PdfExplicitDestination	createFitR(PdfPage page, float left, float bottom, float right, float top)
static PdfExplicitDestination	createFitV(int pageNum, float left) Deprecated. Use PdfExplicitRemoteGoToDestination.createFitV(int, float) instead.
static PdfExplicitDestination	createFitV(PdfPage page, float left)
static PdfExplicitDestination	createXYZ(int pageNum, float left, float top, float zoom) Deprecated. Use PdfExplicitRemoteGoToDestination.createXYZ(int, float, float, float) instead.
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.

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

createXYZ

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

createXYZ

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

Deprecated. Use PdfExplicitRemoteGoToDestination.createXYZ(int, float, float, float) instead.

createFit

public static PdfExplicitDestination createFit(PdfPage page)

createFit

@Deprecated
public static PdfExplicitDestination createFit(int pageNum)

Deprecated. Use PdfExplicitRemoteGoToDestination.createFit(int) instead.

createFitH

public static PdfExplicitDestination createFitH(PdfPage page,
                                                float top)

createFitH

@Deprecated
public static PdfExplicitDestination createFitH(int pageNum,
                                                            float top)

Deprecated. Use PdfExplicitRemoteGoToDestination.createFitH(int, float) instead.

createFitV

public static PdfExplicitDestination createFitV(PdfPage page,
                                                float left)

createFitV

@Deprecated
public static PdfExplicitDestination createFitV(int pageNum,
                                                            float left)

Deprecated. Use PdfExplicitRemoteGoToDestination.createFitV(int, float) instead.

createFitR

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

createFitR

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

Deprecated. Use PdfExplicitRemoteGoToDestination.createFitR(int, float, float, float, float) instead.

createFitB

public static PdfExplicitDestination createFitB(PdfPage page)

createFitB

@Deprecated
public static PdfExplicitDestination createFitB(int pageNum)

Deprecated. Use PdfExplicitRemoteGoToDestination.createFitB(int) instead.

createFitBH

public static PdfExplicitDestination createFitBH(PdfPage page,
                                                 float top)

createFitBH

@Deprecated
public static PdfExplicitDestination createFitBH(int pageNum,
                                                             float top)

Deprecated. Use PdfExplicitRemoteGoToDestination.createFitBH(int, float) instead.

createFitBV

public static PdfExplicitDestination createFitBV(PdfPage page,
                                                 float left)

createFitBV

@Deprecated
public static PdfExplicitDestination createFitBV(int pageNum,
                                                             float left)

Deprecated. Use PdfExplicitRemoteGoToDestination.createFitBV(int, float) instead.

create

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

create

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

Deprecated. Use PdfExplicitRemoteGoToDestination.create(int, PdfName, float, float, float, float, float) instead.

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.