PDAnnotationTextMarkup (Apache PDFBox 2.0.0 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
- - org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
  - - org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup

All Implemented Interfaces:

COSObjectable
```
public class PDAnnotationTextMarkup
extends PDAnnotationMarkup
```
This is the abstract class that represents a text markup annotation Introduced in PDF 1.3 specification, except Squiggly lines in 1.4.

Author:

Paul King

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SUB_TYPE_HIGHLIGHT` The types of annotation.
`static String`	`SUB_TYPE_SQUIGGLY` The types of annotation.
`static String`	`SUB_TYPE_STRIKEOUT` The types of annotation.
`static String`	`SUB_TYPE_UNDERLINE` The types of annotation.

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND

Constructor Summary

Constructors
Constructor and Description
`PDAnnotationTextMarkup(COSDictionary field)` Creates a TextMarkup annotation from a COSDictionary, expected to be a correct object definition.
`PDAnnotationTextMarkup(String subType)` Creates a TextMarkup annotation of the specified sub type.

Method Summary

Methods
Modifier and Type	Method and Description
`float[]`	`getQuadPoints()` This will retrieve the set of quadpoints which encompass the areas of this annotation.
`String`	`getSubtype()` This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
`void`	`setQuadPoints(float[] quadPoints)` This will set the set of quadpoints which encompass the areas of this annotation.
`void`	`setSubtype(String subType)` This will set the sub type (and hence appearance, AP taking precedence) For this annotation.

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, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getPage, getRectangle, getStructParent, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUB_TYPE_HIGHLIGHT
```
public static final String SUB_TYPE_HIGHLIGHT
```
    The types of annotation.
    
    See Also:
    Constant Field Values
  - SUB_TYPE_UNDERLINE
```
public static final String SUB_TYPE_UNDERLINE
```
    The types of annotation.
    
    See Also:
    Constant Field Values
  - SUB_TYPE_SQUIGGLY
```
public static final String SUB_TYPE_SQUIGGLY
```
    The types of annotation.
    
    See Also:
    Constant Field Values
  - SUB_TYPE_STRIKEOUT
```
public static final String SUB_TYPE_STRIKEOUT
```
    The types of annotation.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - PDAnnotationTextMarkup
```
public PDAnnotationTextMarkup(String subType)
```
    Creates a TextMarkup annotation of the specified sub type.
    
    Parameters:
    subType - the subtype the annotation represents
  - PDAnnotationTextMarkup
```
public PDAnnotationTextMarkup(COSDictionary field)
```
    Creates a TextMarkup annotation from a COSDictionary, expected to be a correct object definition.
    
    Parameters:
    field - the PDF objet to represent as a field.
- Method Detail
  - setQuadPoints
```
public void setQuadPoints(float[] quadPoints)
```
    This will set the set of quadpoints which encompass the areas of this annotation.
    
    Parameters:
    quadPoints - an array representing the set of area covered
  - getQuadPoints
```
public float[] getQuadPoints()
```
    This will retrieve the set of quadpoints which encompass the areas of this annotation.
    
    Returns:
    An array of floats representing the quad points.
  - setSubtype
```
public void setSubtype(String subType)
```
    This will set the sub type (and hence appearance, AP taking precedence) For this annotation. See the SUB_TYPE_XXX constants for valid values.
    
    Parameters:
    subType - The subtype of the annotation
  - getSubtype
```
public String getSubtype()
```
    This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
    
    Overrides:
    
    getSubtype in class PDAnnotation
    
    Returns:
    The subtype of this annotation, see the SUB_TYPE_XXX constants.

Class PDAnnotationTextMarkup

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

SUB_TYPE_HIGHLIGHT

SUB_TYPE_UNDERLINE

SUB_TYPE_SQUIGGLY

SUB_TYPE_STRIKEOUT

Constructor Detail

PDAnnotationTextMarkup

PDAnnotationTextMarkup

Method Detail

setQuadPoints

getQuadPoints

setSubtype

getSubtype