Class PDViewportDictionary
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
- All Implemented Interfaces:
COSObjectable
public class PDViewportDictionary extends java.lang.Object implements COSObjectable
This class represents a viewport dictionary.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TYPE
The type of this object.private COSDictionary
viewportDictionary
-
Constructor Summary
Constructors Constructor Description PDViewportDictionary()
Constructor.PDViewportDictionary(COSDictionary dictionary)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PDRectangle
getBBox()
This will retrieve the rectangle specifying the location of the viewport.COSDictionary
getCOSObject()
This will return the corresponding dictionary.PDMeasureDictionary
getMeasure()
This will retrieve the measure dictionary.java.lang.String
getName()
This will retrieve the name of the viewport.java.lang.String
getType()
Returns the type of the viewport dictionary.void
setBBox(PDRectangle rectangle)
This will set the rectangle specifying the location of the viewport.void
setMeasure(PDMeasureDictionary measure)
This will set the measure dictionary.void
setName(java.lang.String name)
This will set the name of the viewport.
-
-
-
Field Detail
-
TYPE
public static final java.lang.String TYPE
The type of this object.- See Also:
- Constant Field Values
-
viewportDictionary
private final COSDictionary viewportDictionary
-
-
Constructor Detail
-
PDViewportDictionary
public PDViewportDictionary()
Constructor.
-
PDViewportDictionary
public PDViewportDictionary(COSDictionary dictionary)
Constructor.- Parameters:
dictionary
- the dictionary
-
-
Method Detail
-
getCOSObject
public COSDictionary getCOSObject()
This will return the corresponding dictionary.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- the viewport dictionary
-
getType
public java.lang.String getType()
Returns the type of the viewport dictionary. It must be "Viewport"- Returns:
- the type of the external data dictionary
-
getBBox
public PDRectangle getBBox()
This will retrieve the rectangle specifying the location of the viewport.- Returns:
- the location
-
setBBox
public void setBBox(PDRectangle rectangle)
This will set the rectangle specifying the location of the viewport.- Parameters:
rectangle
- the rectangle specifying the location.
-
getName
public java.lang.String getName()
This will retrieve the name of the viewport.- Returns:
- the name of the viewport
-
setName
public void setName(java.lang.String name)
This will set the name of the viewport.- Parameters:
name
- the name of the viewport
-
getMeasure
public PDMeasureDictionary getMeasure()
This will retrieve the measure dictionary.- Returns:
- the measure dictionary
-
setMeasure
public void setMeasure(PDMeasureDictionary measure)
This will set the measure dictionary.- Parameters:
measure
- the measure dictionary
-
-