Top Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.annotation

public Class PDAnnotationSquare

extends PDAnnotationSquareCircle
Class Inheritance
Imports
org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAppearanceHandler, .PDSquareAppearanceHandler

Author
Paul King

Field Summary

Modifier and TypeField and Description
private PDAppearanceHandler
public static final String
SUB_TYPE

The type of annotation.

Constructor Summary

AccessConstructor and Description
public
public
PDAnnotationSquare(COSDictionary
the PDF object to represent as a field.
field
)

Creates a square annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Modifier and TypeMethod and Description
public void
public void
constructAppearances(PDDocument
the related document
document
)

Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Create the appearance entry for this annotation.

public void
setCustomAppearanceHandler(PDAppearanceHandler
custom appearance handler
appearanceHandler
)

Set a custom appearance handler for generating the annotations appearance streams.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle:
getBorderEffectgetInteriorColorgetRectDifferencegetRectDifferencessetBorderEffectsetInteriorColorsetRectDifferencesetRectDifferencessetRectDifferences

Field Detail

customAppearanceHandlerback to summary
private PDAppearanceHandler customAppearanceHandler
SUB_TYPEback to summary
public static final String SUB_TYPE

The type of annotation.

Constructor Detail

PDAnnotationSquareback to summary
public PDAnnotationSquare()
PDAnnotationSquareback to summary
public PDAnnotationSquare(COSDictionary field)

Creates a square annotation from a COSDictionary, expected to be a correct object definition.

Parameters
field:COSDictionary

the PDF object to represent as a field.

Method Detail

constructAppearancesback to summary
public void constructAppearances()

Implements abstract org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle.constructAppearances.

Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Annotations
@Override
constructAppearancesback to summary
public void constructAppearances(PDDocument document)

Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Parameters
document:PDDocument

the related document

Annotations
@Override
setCustomAppearanceHandlerback to summary
public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)

Set a custom appearance handler for generating the annotations appearance streams.

Parameters
appearanceHandler:PDAppearanceHandler

custom appearance handler