Class MarkupAnnotation

java.lang.Object

org.openpdf.renderer.annotation.PDFAnnotation

org.openpdf.renderer.annotation.MarkupAnnotation

Direct Known Subclasses:

CircleAnnotation, FreetextAnnotation, SquareAnnotation, StampAnnotation, TextMarkupAnnotation

public class MarkupAnnotation
extends PDFAnnotation

PDF annotation describing a all kind of "markup" annotations which are visible in the PDF.

Nested Class Summary

Nested classes/interfaces inherited from class PDFAnnotation

PDFAnnotation.Flags

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	appearanceStateOn
private AnnotationBorderStyle	borderStyle
private PDFObject	offAppearance
private List<PDFCmd>	offCmd
private PDFObject	onAppearance
private List<PDFCmd>	onCmd
private PDFAnnotation	popupAnnotation
private String	textLabel

Fields inherited from class PDFAnnotation

GOTO, GOTOE, GOTOR, URI

Constructor Summary

Constructors

Constructor	Description
MarkupAnnotation(PDFObject annotObject, AnnotationType type)	Constructor

Method Summary

Modifier and Type	Method	Description
AnnotationBorderStyle	getBorderStyle()
PDFObject	getCurrentAppearance()
List<PDFCmd>	getCurrentCommand()
PDFObject	getOffAppearance()
PDFObject	getOnAppearance()
List<PDFCmd>	getPageCommandsForAnnotation()	Get list of pdf commands for this annotation
PDFAnnotation	getPopupAnnotation()
private AffineTransform	getPositionTransformation()	Transform to the position of the stamp annotation
String	getTextLabel()
boolean	isAppearanceStateOn()
protected void	parseAP(PDFObject dictRef)	Parses the appearance stream into PDF commands
protected void	parseBorderStyleDictionary(PDFObject bs)	Parses the border style dictionary
private List<PDFCmd>	parseIntoPdfCommands(PDFObject obj)
private void	parseOnOffCommands()	Parses the mouse On or Off appearance stream depending on which one is currently active.
private void	parsePopupAnnotation(PDFObject popupObj)	Parses the popup annotation
void	switchAppearance()

Methods inherited from class PDFAnnotation

createAnnotation, getAnnotationName, getAppearanceState, getContents, getFlags, getModified, getPdfObj, getRect, getScalingTransformation, getSubType, getType, isFlagSet, parseRect, toString

Methods inherited from class Object

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

Field Details

onAppearance

private PDFObject onAppearance

offAppearance

private PDFObject offAppearance

onCmd

private List<PDFCmd> onCmd

offCmd

private List<PDFCmd> offCmd

appearanceStateOn

private boolean appearanceStateOn

borderStyle

private AnnotationBorderStyle borderStyle

textLabel

private String textLabel

popupAnnotation

private PDFAnnotation popupAnnotation

Constructor Details

MarkupAnnotation

public MarkupAnnotation(PDFObject annotObject,
 AnnotationType type)
                 throws IOException

Constructor

Parameters:

annotObject -

Throws:

IOException

Method Details

parseAP

protected void parseAP(PDFObject dictRef)
                throws IOException

Parses the appearance stream into PDF commands

Parameters:

dictRef -

Throws:

IOException

parseOnOffCommands

private void parseOnOffCommands()
                         throws IOException

Parses the mouse On or Off appearance stream depending on which one is currently active.

Throws:

IOException

parseBorderStyleDictionary

protected void parseBorderStyleDictionary(PDFObject bs)
                                   throws IOException

Parses the border style dictionary

Parameters:

bs -

Throws:

IOException

getBorderStyle

public AnnotationBorderStyle getBorderStyle()

Returns:

the border style or null if not specified.

parsePopupAnnotation

private void parsePopupAnnotation(PDFObject popupObj)
                           throws IOException

Parses the popup annotation

Parameters:

popupObj -

Throws:

IOException

parseIntoPdfCommands

private List<PDFCmd> parseIntoPdfCommands(PDFObject obj)
                                   throws IOException

Throws:

IOException

getPositionTransformation

private AffineTransform getPositionTransformation()

Transform to the position of the stamp annotation

Returns:

getOnAppearance

public PDFObject getOnAppearance()

Returns:

the onAppearance

getOffAppearance

public PDFObject getOffAppearance()

Returns:

the offAppearance

isAppearanceStateOn

public boolean isAppearanceStateOn()

Returns:

the appearanceStateOn

switchAppearance

public void switchAppearance()

getCurrentAppearance

public PDFObject getCurrentAppearance()

getCurrentCommand

public List<PDFCmd> getCurrentCommand()

getPageCommandsForAnnotation

public List<PDFCmd> getPageCommandsForAnnotation()

Description copied from class: PDFAnnotation

Get list of pdf commands for this annotation

Overrides:

getPageCommandsForAnnotation in class PDFAnnotation

Returns:

getPopupAnnotation

public PDFAnnotation getPopupAnnotation()

Returns:

the popupAnnotation

getTextLabel

public String getTextLabel()