org.apache.pdfbox.pdmodel.interactive.annotation

Class PDAnnotationHighlight

java.lang.Object

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

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight

All Implemented Interfaces:

COSObjectable

public class PDAnnotationHighlight
extends PDAnnotationTextMarkup

Author:

Paul King

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUB_TYPE The type of annotation.

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

RT_GROUP, RT_REPLY

Constructor Summary

Constructors

Constructor and Description
PDAnnotationHighlight() Constructor.
PDAnnotationHighlight(COSDictionary dict) Constructor.

Method Summary

Modifier and Type	Method and Description
void	constructAppearances() Create the appearance entry for this annotation.
void	constructAppearances(PDDocument document) Create the appearance entry for this annotation.
void	setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler) Set a custom appearance handler for generating the annotations appearance streams.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup

getQuadPoints, setQuadPoints

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

getBorderStyle, getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setBorderStyle, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

createAnnotation, equals, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getOptionalContent, getPage, getRectangle, getStructParent, getSubtype, hashCode, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setLockedContents, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setOptionalContent, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setSubtype, setToggleNoView

Methods inherited from class java.lang.Object

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

Field Detail

SUB_TYPE

public static final String SUB_TYPE

The type of annotation.

See Also:

Constant Field Values

Constructor Detail

PDAnnotationHighlight

public PDAnnotationHighlight()

Constructor.

PDAnnotationHighlight

public PDAnnotationHighlight(COSDictionary dict)

Constructor.

Parameters:

dict - The annotations dictionary.

Method Detail

setCustomAppearanceHandler

public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)

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

Parameters:

appearanceHandler - custom appearance handler

constructAppearances

public void constructAppearances()

Description copied from class: PDAnnotation

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.

Overrides:

constructAppearances in class PDAnnotation

constructAppearances

public void constructAppearances(PDDocument document)

Description copied from class: PDAnnotation

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.

Overrides:

constructAppearances in class PDAnnotation

Parameters:

document - the related document