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

All Implemented Interfaces:
    COSObjectable

Direct Known Subclasses:
    PDAnnotationFileAttachment, PDAnnotationTextMarkup, PDAnnotationRubberStamp, PDAnnotationSquareCircle, PDAnnotationLine, PDAnnotationText

This class represents the additonal fields of a Markup type Annotation.
Field Summary
public static final  String RT_REPLY    Constant for an annotation reply type. 
public static final  String RT_GROUP    Constant for an annotation reply type. 
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 PDAnnotationMarkup() 
 public PDAnnotationMarkup(COSDictionary dict) 
    Constructor.
    Parameters:
    dict - The annotations dictionary.
Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup Summary:
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.PDAnnotationMarkup Detail:
 public float getConstantOpacity() 
    This will retrieve the constant opacity value used when rendering the annotation (excluing any popup).
 public Calendar getCreationDate() throws IOException 
    This will retrieve the date and time the annotation was created.
 public PDExternalDataDictionary getExternalData() 
    This will return the external data dictionary.
 public PDAnnotation getInReplyTo() throws IOException 
    This will retrieve the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
 public String getIntent() 
    This will retrieve the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
 public PDAnnotationPopup getPopup() 
    This will retrieve the popup annotation used for entering/editing the text for this annotation.
 public String getReplyType() 
    This will retrieve the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
 public PDTextStream getRichContents() 
    This will retrieve the rich text stream which is displayed in the popup window.
 public String getSubject() 
    This will retrieve the short description of the subject of the annotation.
 public String getTitlePopup() 
    Retrieve the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
 public  void setConstantOpacity(float ca) 
    This will set the constant opacity value used when rendering the annotation (excluing any popup).
 public  void setCreationDate(Calendar creationDate) 
    This will set the the date and time the annotation was created.
 public  void setExternalData(PDExternalDataDictionary externalData) 
    This will set the external data dictionary.
 public  void setInReplyTo(PDAnnotation irt) 
    This will set the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
 public  void setIntent(String it) 
    This will set the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
 public  void setPopup(PDAnnotationPopup popup) 
    This will set the popup annotation used for entering/editing the text for this annotation.
 public  void setReplyType(String rt) 
    This will set the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
 public  void setRichContents(PDTextStream rc) 
    This will set the rich text stream which is displayed in the popup window.
 public  void setSubject(String subj) 
    This will set the short description of the subject of the annotation.
 public  void setTitlePopup(String t) 
    Set the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).