Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.annotation » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDAnnotationSquareCircle [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.PDAnnotationSquareCircle

All Implemented Interfaces:
    COSObjectable

This is the class that represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .
Field Summary
public static final  String SUB_TYPE_SQUARE    Constant for a Rectangular type of annotation. 
public static final  String SUB_TYPE_CIRCLE    Constant for an Eliptical 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 PDAnnotationSquareCircle(String subType) 
    Creates a Circle or Square annotation of the specified sub type.
    Parameters:
    subType - the subtype the annotation represents.
 public PDAnnotationSquareCircle(COSDictionary field) 
    Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
    Parameters:
    field - the PDF objet to represent as a field.
Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle Summary:
getBorderEffect,   getBorderStyle,   getInteriorColour,   getRectDifference,   getSubtype,   setBorderEffect,   setBorderStyle,   setInteriorColour,   setRectDifference,   setSubtype
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.PDAnnotationSquareCircle Detail:
 public PDBorderEffectDictionary getBorderEffect() 
    This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.
 public PDBorderStyleDictionary getBorderStyle() 
    This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
 public PDGamma getInteriorColour() 
    This will retrieve the interior colour of the drawn area Colour is in DeviceRGB colourspace.
 public PDRectangle getRectDifference() 
    This will get the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry forexample)
 public String getSubtype() 
    This will retrieve the sub type (and hence appearance, AP taking precedence) For this annotation.
 public  void setBorderEffect(PDBorderEffectDictionary be) 
    This will set the border effect dictionary, specifying effects to be applied when drawing the line.
 public  void setBorderStyle(PDBorderStyleDictionary bs) 
    This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
 public  void setInteriorColour(PDGamma ic) 
    This will set interior colour of the drawn area Colour is in DeviceRGB colourspace.
 public  void setRectDifference(PDRectangle rd) 
    This will set the rectangle difference rectangle. Giving the difference between the annotations rectangle and where the drawing occurs. (To take account of any effects applied through the BE entry forexample)
 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.