Package com.itextpdf.kernel.pdf.navigation

Class PdfStructureDestination

java.lang.Object

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

com.itextpdf.kernel.pdf.navigation.PdfDestination

com.itextpdf.kernel.pdf.navigation.PdfStructureDestination

       public class PdfStructureDestination extends PdfDestination
      

Constructor Summary

Constructors

Constructor	Description
PdfStructureDestination(PdfArray structureDestination)

Method Summary

Modifier and Type	Method	Description
static PdfStructureDestination	createFit(PdfStructElem elem)
static PdfStructureDestination	createFitB(PdfStructElem elem)
static PdfStructureDestination	createFitBH(PdfStructElem elem, float top)
static PdfStructureDestination	createFitBV(PdfStructElem elem, float left)
static PdfStructureDestination	createFitH(PdfStructElem elem, float top)
static PdfStructureDestination	createFitR(PdfStructElem elem, float left, float bottom, float right, float top)
static PdfStructureDestination	createFitV(PdfStructElem elem, float left)
static PdfStructureDestination	createXYZ(PdfStructElem elem, float left, float top, float zoom)
PdfObject	getDestinationPage(IPdfNameTreeAccess 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 Details

PdfStructureDestination

             public PdfStructureDestination
             (PdfArray structureDestination)
            

Method Details

createXYZ

             public static PdfStructureDestination createXYZ
             (PdfStructElem elem, float left, float top, float zoom)
            

createFit

             public static PdfStructureDestination createFit
             (PdfStructElem elem)
            

createFitH

             public static PdfStructureDestination createFitH
             (PdfStructElem elem, float top)
            

createFitV

             public static PdfStructureDestination createFitV
             (PdfStructElem elem, float left)
            

createFitR

             public static PdfStructureDestination createFitR
             (PdfStructElem elem, float left, float bottom, float right, float top)
            

createFitB

             public static PdfStructureDestination createFitB
             (PdfStructElem elem)
            

createFitBH

             public static PdfStructureDestination createFitBH
             (PdfStructElem elem, float top)
            

createFitBV

             public static PdfStructureDestination createFitBV
             (PdfStructElem elem, float left)
            

getDestinationPage

             public PdfObject getDestinationPage
             (IPdfNameTreeAccess names)
            

Specified by:

getDestinationPage in class PdfDestination

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.