Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.measurement

public Class PDViewportDictionary

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSObjectable, .PDRectangle
This class represents a viewport dictionary.

Field Summary

Modifier and TypeField and Description
public static final String
TYPE

The type of this object.

private final COSDictionary
viewportDictionary

Constructor Summary

AccessConstructor and Description
public
PDViewportDictionary()

Constructor.

public
PDViewportDictionary(COSDictionary
the dictionary
dictionary)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public PDRectangle

Returns:

the location
getBBox()

This will retrieve the rectangle specifying the location of the viewport.

public COSDictionary

Returns:

the viewport dictionary
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

This will return the corresponding dictionary.

public PDMeasureDictionary

Returns:

the measure dictionary
getMeasure()

This will retrieve the measure dictionary.

public String

Returns:

the name of the viewport
getName()

This will retrieve the name of the viewport.

public String

Returns:

the type of the external data dictionary
getType()

Returns the type of the viewport dictionary.

public void
setBBox(PDRectangle
the rectangle specifying the location.
rectangle)

This will set the rectangle specifying the location of the viewport.

public void
setMeasure(PDMeasureDictionary
the measure dictionary
measure)

This will set the measure dictionary.

public void
setName(String
the name of the viewport
name)

This will set the name of the viewport.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

TYPEback to summary
public static final String TYPE

The type of this object.

viewportDictionaryback to summary
private final COSDictionary viewportDictionary

Constructor Detail

PDViewportDictionaryback to summary
public PDViewportDictionary()

Constructor.

PDViewportDictionaryback to summary
public PDViewportDictionary(COSDictionary dictionary)

Constructor.

Parameters
dictionary:COSDictionary

the dictionary

Method Detail

getBBoxback to summary
public PDRectangle getBBox()

This will retrieve the rectangle specifying the location of the viewport.

Returns:PDRectangle

the location

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

This will return the corresponding dictionary.

Returns:COSDictionary

the viewport dictionary

Annotations
@Override
getMeasureback to summary
public PDMeasureDictionary getMeasure()

This will retrieve the measure dictionary.

Returns:PDMeasureDictionary

the measure dictionary

getNameback to summary
public String getName()

This will retrieve the name of the viewport.

Returns:String

the name of the viewport

getTypeback to summary
public String getType()

Returns the type of the viewport dictionary. It must be "Viewport"

Returns:String

the type of the external data dictionary

setBBoxback to summary
public void setBBox(PDRectangle rectangle)

This will set the rectangle specifying the location of the viewport.

Parameters
rectangle:PDRectangle

the rectangle specifying the location.

setMeasureback to summary
public void setMeasure(PDMeasureDictionary measure)

This will set the measure dictionary.

Parameters
measure:PDMeasureDictionary

the measure dictionary

setNameback to summary
public void setName(String name)

This will set the name of the viewport.

Parameters
name:String

the name of the viewport