Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.annotation » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDAnnotationText [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
      org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
         org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText

All Implemented Interfaces:
    COSObjectable

This is the class that represents a text annotation.
Field Summary
public static final  String NAME_COMMENT    Constant for the name of a text annotation. 
public static final  String NAME_KEY    Constant for the name of a text annotation. 
public static final  String NAME_NOTE    Constant for the name of a text annotation. 
public static final  String NAME_HELP    Constant for the name of a text annotation. 
public static final  String NAME_NEW_PARAGRAPH    Constant for the name of a text annotation. 
public static final  String NAME_PARAGRAPH    Constant for the name of a text annotation. 
public static final  String NAME_INSERT    Constant for the name of a text annotation. 
public static final  String SUB_TYPE    The type of annotation. 
Fields inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
RT_REPLY,  RT_GROUP
Fields inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
FLAG_INVISIBLE,  FLAG_HIDDEN,  FLAG_PRINTED,  FLAG_NO_ZOOM,  FLAG_NO_ROTATE,  FLAG_NO_VIEW,  FLAG_READ_ONLY,  FLAG_LOCKED,  FLAG_TOGGLE_NO_VIEW
Constructor:
 public PDAnnotationText() 
 public PDAnnotationText(COSDictionary field) 
    Creates a Text annotation from a COSDictionary, expected to be a correct object definition.
    Parameters:
    field - the PDF object to represent as a field.
Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText Summary:
getName,   getOpen,   getState,   getStateModel,   setName,   setOpen,   setState,   setStateModel
Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
getConstantOpacity,   getCreationDate,   getExternalData,   getInReplyTo,   getIntent,   getPopup,   getReplyType,   getRichContents,   getSubject,   getTitlePopup,   setConstantOpacity,   setCreationDate,   setExternalData,   setInReplyTo,   setIntent,   setPopup,   setReplyType,   setRichContents,   setSubject,   setTitlePopup
Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
createAnnotation,   getAnnotationFlags,   getAnnotationName,   getAppearance,   getAppearanceStream,   getCOSObject,   getColour,   getContents,   getDictionary,   getModifiedDate,   getPage,   getRectangle,   getSubtype,   isHidden,   isInvisible,   isLocked,   isNoRotate,   isNoView,   isNoZoom,   isPrinted,   isReadOnly,   isToggleNoView,   setAnnotationFlags,   setAnnotationName,   setAppearance,   setAppearanceStream,   setColour,   setContents,   setHidden,   setInvisible,   setLocked,   setModifiedDate,   setNoRotate,   setNoView,   setNoZoom,   setPrinted,   setReadOnly,   setRectangle,   setToggleNoView
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText Detail:
 public String getName() 
    This will retrieve the name (and hence appearance, AP taking precedence) For this annotation. The default is NOTE.
 public boolean getOpen() 
    This will retrieve the initial state of the annotation, open Or closed (default closed).
 public String getState() 
    This will retrieve the annotation state.
 public String getStateModel() 
    This will retrieve the annotation state model.
 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.
 public  void setOpen(boolean open) 
    This will set initial state of the annotation, open or closed.
 public  void setState(String state) 
    This will set the annotation state.
 public  void setStateModel(String stateModel) 
    This will set the annotation state model. Allowed values are "Marked" and "Review"