com.itextpdf.forms.xfdf

Class DestObject

java.lang.Object

com.itextpdf.forms.xfdf.DestObject

public class DestObject
extends Object

Represents Dest element, a child of the link, GoTo, and GoToR elements. Corresponds to the Dest key in the link annotations dictionary. For more details see paragraph 6.5.10 in XFDF document specification. Content model: ( Named | XYZ | Fit | FitH | FitV | FitR | FitB | FitBH | FitBV )

Constructor Summary

Constructors

Constructor and Description
DestObject()

Method Summary

Modifier and Type	Method and Description
FitObject	getFit() Gets the Fit element, a child of the Dest element.
FitObject	getFitB() Sets the FitB element, a child of the Dest element.
FitObject	getFitBH() Sets the FitBH element, a child of the Dest element.
FitObject	getFitBV() Sets the FitBV element, a child of the Dest element.
FitObject	getFitH() Gets the FitH element, a child of the Dest element.
FitObject	getFitR() Gets the FitR element, a child of the Dest element.
FitObject	getFitV() Gets the FitV element, a child of the Dest element.
String	getName() Gets the Name attribute of Named element, a child of Dest element.
FitObject	getXyz() Gets the XYZ element, a child of the Dest element.
DestObject	setFit(FitObject fit) Sets the Fit element, a child of the Dest element.
DestObject	setFitB(FitObject fitB) Gets the FitB element, a child of the Dest element.
DestObject	setFitBH(FitObject fitBH) Gets the FitBH element, a child of the Dest element.
DestObject	setFitBV(FitObject fitBV) Sets the FitBV element, a child of the Dest element.
DestObject	setFitH(FitObject fitH) Sets the FitH element, a child of the Dest element.
DestObject	setFitR(FitObject fitR) Sets the FitR element, a child of the Dest element.
DestObject	setFitV(FitObject fitV) Sets the FitV element, a child of the Dest element.
DestObject	setName(String name) Sets the Name attribute of Named element, a child of Dest element.
DestObject	setXyz(FitObject xyz) Sets the XYZ element, a child of the Dest element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DestObject

public DestObject()

Method Detail

getName

public String getName()

Gets the Name attribute of Named element, a child of Dest element. Allows a destination to be referred to indirectly by means of a name object or a byte string. For more details see paragraph 6.5.25 in XFDF document specification.

Returns:

string value of the Name attribute.

setName

public DestObject setName(String name)

Sets the Name attribute of Named element, a child of Dest element. Allows a destination to be referred to indirectly by means of a name object or a byte string.

Parameters:

name - string value of the Name attribute.

Returns:

this DestObject instance.

getXyz

public FitObject getXyz()

Gets the XYZ element, a child of the Dest element. Corresponds to the XYZ key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. For more details see paragraph 6.5.32 in XFDF document specification.

Returns:

a FitObject that represents XYZ of Dest element.

setXyz

public DestObject setXyz(FitObject xyz)

Sets the XYZ element, a child of the Dest element. Corresponds to the XYZ key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top.

Parameters:

xyz - a FitObject that represents XYZ of Dest element.

Returns:

this DestObject instance.

getFit

public FitObject getFit()

Gets the Fit element, a child of the Dest element. Corresponds to the Fit key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.13 in XFDF document specification.

Returns:

a FitObject that represents Fit of Dest element.

setFit

public DestObject setFit(FitObject fit)

Sets the Fit element, a child of the Dest element. Corresponds to the Fit key in the destination syntax. Required attributes: Page.

Parameters:

fit - a FitObject that represents Fit of Dest element.

Returns:

this DestObject instance.

getFitH

public FitObject getFitH()

Gets the FitH element, a child of the Dest element. Corresponds to the FitH key in the destination syntax. Required attributes: Page, Top. For more details see paragraph 6.5.17 in XFDF document specification.

Returns:

a FitObject that represents FitH of Dest element.

setFitH

public DestObject setFitH(FitObject fitH)

Sets the FitH element, a child of the Dest element. Corresponds to the FitH key in the destination syntax. Required attributes: Page, Top.

Parameters:

fitH - a FitObject that represents FitH of Dest element.

Returns:

this DestObject instance.

getFitV

public FitObject getFitV()

Gets the FitV element, a child of the Dest element. Corresponds to the FitV key in the destination syntax. Required attributes: Page, Left. For more details see paragraph 6.5.19 in XFDF document specification.

Returns:

a FitObject that represents FitV of Dest element.

setFitV

public DestObject setFitV(FitObject fitV)

Sets the FitV element, a child of the Dest element. Corresponds to the FitV key in the destination syntax. Required attributes: Page, Left.

Parameters:

fitV - a FitObject that represents FitV of Dest element.

Returns:

this DestObject instance.

getFitR

public FitObject getFitR()

Gets the FitR element, a child of the Dest element. Corresponds to the FitR key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. For more details see paragraph 6.5.18 in XFDF document specification.

Returns:

a FitObject that represents FitR of Dest element.

setFitR

public DestObject setFitR(FitObject fitR)

Sets the FitR element, a child of the Dest element. Corresponds to the FitR key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top.

Parameters:

fitR - a FitObject that represents FitR of Dest element.

Returns:

this DestObject instance.

getFitB

public FitObject getFitB()

Sets the FitB element, a child of the Dest element. Corresponds to the FitB key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.14 in XFDF document specification.

Returns:

a FitObject that represents FitB of Dest element.

setFitB

public DestObject setFitB(FitObject fitB)

Gets the FitB element, a child of the Dest element. Corresponds to the FitB key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.14 in XFDF document specification.

Parameters:

fitB - a FitObject that represents FitB of Dest element.

Returns:

this DestObject instance.

getFitBH

public FitObject getFitBH()

Sets the FitBH element, a child of the Dest element. Corresponds to the FitBH key in the destination syntax. Required attributes: Page, Top. For more details see paragraph 6.5.15 in XFDF document specification.

Returns:

a FitObject that represents FitBH of Dest element.

setFitBH

public DestObject setFitBH(FitObject fitBH)

Gets the FitBH element, a child of the Dest element. Corresponds to the FitBH key in the destination syntax. Required attributes: Page, Top.

Parameters:

fitBH - a FitObject that represents FitBH of Dest element.

Returns:

this DestObject instance.

getFitBV

public FitObject getFitBV()

Sets the FitBV element, a child of the Dest element. Corresponds to the FitBV key in the destination syntax. Required attributes: Page, Left. For more details see paragraph 6.5.16 in XFDF document specification.

Returns:

a FitObject that represents FitBV of Dest element.

setFitBV

public DestObject setFitBV(FitObject fitBV)

Sets the FitBV element, a child of the Dest element. Corresponds to the FitBV key in the destination syntax. Required attributes: Page, Left.

Parameters:

fitBV - a FitObject that represents FitBV of Dest element.

Returns:

this DestObject instance.