public class PDAnnotationLine extends PDAnnotationMarkup
Modifier and Type | Field and Description |
---|---|
static String |
IT_LINE_ARROW
Constant for annotation intent of Arrow.
|
static String |
IT_LINE_DIMENSION
Constant for annotation intent of a dimension line.
|
static String |
LE_BUTT
Constant for a butt line ending.
|
static String |
LE_CIRCLE
Constant for a circle line ending.
|
static String |
LE_CLOSED_ARROW
Constant for a closed arrow line ending.
|
static String |
LE_DIAMOND
Constant for a diamond line ending.
|
static String |
LE_NONE
Constant for no line ending.
|
static String |
LE_OPEN_ARROW
Constant for a open arrow line ending.
|
static String |
LE_R_CLOSED_ARROW
Constant for a revered closed arrow line ending.
|
static String |
LE_R_OPEN_ARROW
Constant for a reversed open arrow line ending.
|
static String |
LE_SLASH
Constant for a slash line ending.
|
static String |
LE_SQUARE
Constant for a square line ending.
|
static String |
SUB_TYPE
The type of annotation.
|
RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND
Constructor and Description |
---|
PDAnnotationLine()
Constructor.
|
PDAnnotationLine(COSDictionary field)
Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
|
Modifier and Type | Method and Description |
---|---|
PDBorderStyleDictionary |
getBorderStyle()
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
|
boolean |
getCaption()
This will retrieve if the contents are shown as a caption or not.
|
float |
getCaptionHorizontalOffset()
This will retrieve the horizontal offset of the caption.
|
String |
getCaptionPositioning()
This will retrieve the caption positioning.
|
float |
getCaptionVerticalOffset()
This will retrieve the vertical offset of the caption.
|
String |
getEndPointEndingStyle()
This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
|
PDColor |
getInteriorColor()
This will retrieve the interior color of the line endings defined in the LE entry. color is in DeviceRGB color
space.
|
float |
getLeaderLineExtensionLength()
This will retrieve the length of the leader line extensions.
|
float |
getLeaderLineLength()
This will retrieve the length of the leader line.
|
float |
getLeaderLineOffsetLength()
This will retrieve the length of the leader line offset.
|
float[] |
getLine()
This will retrieve the start and end coordinates of the line (or leader line if LL entry is set).
|
String |
getStartPointEndingStyle()
This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
|
void |
setBorderStyle(PDBorderStyleDictionary bs)
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
|
void |
setCaption(boolean cap)
This will set if the contents are shown as a caption to the line.
|
void |
setCaptionHorizontalOffset(float offset)
This will set the horizontal offset of the caption.
|
void |
setCaptionPositioning(String captionPositioning)
This will set the caption positioning.
|
void |
setCaptionVerticalOffset(float offset)
This will set the vertical offset of the caption.
|
void |
setEndPointEndingStyle(String style)
This will set the line ending style for the end point, see the LE_ constants for the possible values.
|
void |
setInteriorColor(PDColor ic)
This will set interior color of the line endings defined in the LE entry. color is in DeviceRGB color space.
|
void |
setLeaderLineExtensionLength(float leaderLineExtensionLength)
This will set the length of the leader line extensions.
|
void |
setLeaderLineLength(float leaderLineLength)
This will set the length of the leader line.
|
void |
setLeaderLineOffsetLength(float leaderLineOffsetLength)
This will set the length of the leader line offset.
|
void |
setLine(float[] l)
This will set start and end coordinates of the line (or leader line if LL entry is set).
|
void |
setStartPointEndingStyle(String style)
This will set the line ending style for the start point, see the LE_ constants for the possible values.
|
getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
public static final String IT_LINE_ARROW
public static final String IT_LINE_DIMENSION
public static final String LE_SQUARE
public static final String LE_CIRCLE
public static final String LE_DIAMOND
public static final String LE_OPEN_ARROW
public static final String LE_CLOSED_ARROW
public static final String LE_NONE
public static final String LE_BUTT
public static final String LE_R_OPEN_ARROW
public static final String LE_R_CLOSED_ARROW
public static final String LE_SLASH
public static final String SUB_TYPE
public PDAnnotationLine()
public PDAnnotationLine(COSDictionary field)
field
- the PDF object to represent as a field.public void setLine(float[] l)
l
- array of 4 floats [x1, y1, x2, y2] line start and end points in default user space.public float[] getLine()
public void setStartPointEndingStyle(String style)
style
- The new style.public String getStartPointEndingStyle()
public void setEndPointEndingStyle(String style)
style
- The new style.public String getEndPointEndingStyle()
public void setInteriorColor(PDColor ic)
ic
- color in the DeviceRGB color space.public PDColor getInteriorColor()
public void setCaption(boolean cap)
cap
- Boolean value.public boolean getCaption()
public void setBorderStyle(PDBorderStyleDictionary bs)
setBorderStyle
in class PDAnnotationMarkup
bs
- the border style dictionary to set.public PDBorderStyleDictionary getBorderStyle()
getBorderStyle
in class PDAnnotationMarkup
public float getLeaderLineLength()
public void setLeaderLineLength(float leaderLineLength)
leaderLineLength
- length of the leader linepublic float getLeaderLineExtensionLength()
public void setLeaderLineExtensionLength(float leaderLineExtensionLength)
leaderLineExtensionLength
- length of the leader line extensionspublic float getLeaderLineOffsetLength()
public void setLeaderLineOffsetLength(float leaderLineOffsetLength)
leaderLineOffsetLength
- length of the leader line offsetpublic String getCaptionPositioning()
public void setCaptionPositioning(String captionPositioning)
captionPositioning
- caption positioningpublic void setCaptionHorizontalOffset(float offset)
offset
- the horizontal offset of the captionpublic float getCaptionHorizontalOffset()
public void setCaptionVerticalOffset(float offset)
offset
- vertical offset of the captionpublic float getCaptionVerticalOffset()
Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.