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

All Implemented Interfaces:
    COSObjectable

This is the class that represents a line annotation. Introduced in PDF 1.3 specification
Field Summary
public static final  String IT_LINE_ARROW    Constant for annotation intent of Arrow. 
public static final  String IT_LINE_DIMENSION    Constant for annotation intent of a dimension line. 
public static final  String LE_SQUARE    Constant for a square line ending. 
public static final  String LE_CIRCLE    Constant for a circle line ending. 
public static final  String LE_DIAMOND    Constant for a diamond line ending. 
public static final  String LE_OPEN_ARROW    Constant for a open arrow line ending. 
public static final  String LE_CLOSED_ARROW    Constant for a closed arrow line ending. 
public static final  String LE_NONE    Constant for no line ending. 
public static final  String LE_BUTT    Constant for a butt line ending. 
public static final  String LE_R_OPEN_ARROW    Constant for a reversed open arrow line ending. 
public static final  String LE_R_CLOSED_ARROW    Constant for a revered closed arrow line ending. 
public static final  String LE_SLASH    Constant for a slash line ending. 
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 PDAnnotationLine() 
 public PDAnnotationLine(COSDictionary field) 
    Creates a Line 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.PDAnnotationLine Summary:
getBorderStyle,   getCaption,   getCaptionHorizontalOffset,   getCaptionPositioning,   getCaptionVerticalOffset,   getEndPointEndingStyle,   getInteriorColour,   getLeaderLineExtensionLength,   getLeaderLineLength,   getLeaderLineOffsetLength,   getLine,   getStartPointEndingStyle,   setBorderStyle,   setCaption,   setCaptionHorizontalOffset,   setCaptionPositioning,   setCaptionVerticalOffset,   setEndPointEndingStyle,   setInteriorColour,   setLeaderLineExtensionLength,   setLeaderLineLength,   setLeaderLineOffsetLength,   setLine,   setStartPointEndingStyle
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.PDAnnotationLine Detail:
 public PDBorderStyleDictionary getBorderStyle() 
    This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
 public boolean getCaption() 
    This will retrieve if the contents are shown as a caption or not.
 public float getCaptionHorizontalOffset() 
    This will retrieve the horizontal offset of the caption.
 public String getCaptionPositioning() 
    This will retrieve the caption positioning.
 public float getCaptionVerticalOffset() 
    This will retrieve the vertical offset of the caption.
 public String getEndPointEndingStyle() 
    This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
 public PDGamma getInteriorColour() 
    This will retrieve the interior colour of the line endings defined in the LE entry. Colour is in DeviceRGB colourspace.
 public float getLeaderLineExtensionLength() 
    This will retrieve the length of the leader line extensions.
 public float getLeaderLineLength() 
    This will retrieve the length of the leader line.
 public float getLeaderLineOffsetLength() 
    This will retrieve the length of the leader line offset.
 public float[] getLine() 
    This will retrieve the start and end coordinates of the line (or leader line if LL entry is set).
 public String getStartPointEndingStyle() 
    This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
 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 setCaption(boolean cap) 
    This will set if the contents are shown as a caption to the line.
 public  void setCaptionHorizontalOffset(float offset) 
    This will set the horizontal offset of the caption.
 public  void setCaptionPositioning(String captionPositioning) 
    This will set the caption positioning. Allowed values are: "Inline" and "Top"
 public  void setCaptionVerticalOffset(float offset) 
    This will set the vertical offset of the caption.
 public  void setEndPointEndingStyle(String style) 
    This will set the line ending style for the end point, see the LE_ constants for the possible values.
 public  void setInteriorColour(PDGamma ic) 
    This will set interior colour of the line endings defined in the LE entry. Colour is in DeviceRGB colourspace.
 public  void setLeaderLineExtensionLength(float leaderLineExtensionLength) 
    This will set the length of the leader line extensions.
 public  void setLeaderLineLength(float leaderLineLength) 
    This will set the length of the leader line.
 public  void setLeaderLineOffsetLength(float leaderLineOffsetLength) 
    This will set the length of the leader line offset.
 public  void setLine(float[] l) 
    This will set start and end coordinates of the line (or leader line if LL entry is set).
 public  void setStartPointEndingStyle(String style) 
    This will set the line ending style for the start point, see the LE_ constants for the possible values.