org.pdfbox.pdmodel.interactive.annotation
Class PDAnnotationText
- COSObjectable
public class PDAnnotationText
This is the class that represents a text annotation.
static String | NAME_COMMENT- Constant for the name of a text annotation.
|
static String | NAME_HELP- Constant for the name of a text annotation.
|
static String | NAME_INSERT- Constant for the name of a text annotation.
|
static String | NAME_KEY- Constant for the name of a text annotation.
|
static String | NAME_NEW_PARAGRAPH- Constant for the name of a text annotation.
|
static String | NAME_NOTE- Constant for the name of a text annotation.
|
static String | NAME_PARAGRAPH- Constant for the name of a text annotation.
|
static String | SUB_TYPE- The type of annotation.
|
String | getName()- This will retrieve the name (and hence appearance, AP taking precedence)
For this annotation.
|
boolean | getOpen()- This will retrieve the initial state of the annotation, open Or closed
(default closed).
|
void | setName(String name)- This will set the name (and hence appearance, AP taking precedence) For
this annotation.
|
void | setOpen(boolean open)- This will set inital state of the annotation, open or closed.
|
getConstantOpacity, getCreationDate, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setConstantOpacity, setCreationDate, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup |
createAnnotation, getAction, getActions, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getBoderStyle, getCOSObject, getColour, getContents, getDictionary, getModifiedDate, getRectangle, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAction, setActions, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setBorderStyle, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPrinted, setReadOnly, setRectangle, setToggleNoView |
NAME_COMMENT
public static final String NAME_COMMENT
Constant for the name of a text annotation.
NAME_HELP
public static final String NAME_HELP
Constant for the name of a text annotation.
NAME_INSERT
public static final String NAME_INSERT
Constant for the name of a text annotation.
NAME_KEY
public static final String NAME_KEY
Constant for the name of a text annotation.
NAME_NEW_PARAGRAPH
public static final String NAME_NEW_PARAGRAPH
Constant for the name of a text annotation.
NAME_NOTE
public static final String NAME_NOTE
Constant for the name of a text annotation.
NAME_PARAGRAPH
public static final String NAME_PARAGRAPH
Constant for the name of a text annotation.
SUB_TYPE
public static final String SUB_TYPE
The type of annotation.
PDAnnotationText
public PDAnnotationText()
Constructor.
PDAnnotationText
public PDAnnotationText(COSDictionary field)
Creates a Text annotation from a COSDictionary, expected to be a correct
object definition.
field - the PDF objet to represent as a field.
getName
public String getName()
This will retrieve the name (and hence appearance, AP taking precedence)
For this annotation. The default is NOTE.
- The name of this annotation, see the NAME_XXX constants.
getOpen
public boolean getOpen()
This will retrieve the initial state of the annotation, open Or closed
(default closed).
- The initial state, true = open false = closed
setName
public void setName(String name)
This will set the name (and hence appearance, AP taking precedence) For
this annotation. See the NAME_XXX constants for valid values.
name - The name of the annotation
setOpen
public void setOpen(boolean open)
This will set inital state of the annotation, open or closed.
open - Boolean value, true = open false = closed