COSObjectable
public class PDAnnotationLine extends PDAnnotationMarkup
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
IT_LINE_ARROW |
Constant for annotation intent of Arrow.
|
static java.lang.String |
IT_LINE_DIMENSION |
Constant for annotation intent of a dimension line.
|
static java.lang.String |
LE_BUTT |
Constant for a butt line ending.
|
static java.lang.String |
LE_CIRCLE |
Constant for a circle line ending.
|
static java.lang.String |
LE_CLOSED_ARROW |
Constant for a closed arrow line ending.
|
static java.lang.String |
LE_DIAMOND |
Constant for a diamond line ending.
|
static java.lang.String |
LE_NONE |
Constant for no line ending.
|
static java.lang.String |
LE_OPEN_ARROW |
Constant for a open arrow line ending.
|
static java.lang.String |
LE_R_CLOSED_ARROW |
Constant for a revered closed arrow line ending.
|
static java.lang.String |
LE_R_OPEN_ARROW |
Constant for a reversed open arrow line ending.
|
static java.lang.String |
LE_SLASH |
Constant for a slash line ending.
|
static java.lang.String |
LE_SQUARE |
Constant for a square line ending.
|
static java.lang.String |
SUB_TYPE |
The type of annotation.
|
FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINTED, FLAG_READ_ONLY, FLAG_TOGGLE_NO_VIEW
RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND
Constructor | Description |
---|---|
PDAnnotationLine() |
Constructor.
|
PDAnnotationLine(COSDictionary field) |
Creates a Line annotation from a COSDictionary, expected to be a correct
object definition.
|
Modifier and Type | Method | 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.
|
java.lang.String |
getCaptionPositioning() |
This will retrieve the caption positioning.
|
float |
getCaptionVerticalOffset() |
This will retrieve the vertical offset of the caption.
|
java.lang.String |
getEndPointEndingStyle() |
This will retrieve the line ending style for the end point,
possible values shown in the LE_ constants section.
|
PDGamma |
getInteriorColour() |
This will retrieve the interior colour of the line endings defined in the
LE entry.
|
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).
|
java.lang.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(java.lang.String captionPositioning) |
This will set the caption positioning.
|
void |
setCaptionVerticalOffset(float offset) |
This will set the vertical offset of the caption.
|
void |
setEndPointEndingStyle(java.lang.String style) |
This will set the line ending style for the end point,
see the LE_ constants for the possible values.
|
void |
setInteriorColour(PDGamma ic) |
This will set interior colour of the line endings defined in the LE
entry.
|
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(java.lang.String style) |
This will set the line ending style for the start point,
see the LE_ constants for the possible values.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getColour, getContents, getCOSObject, getDictionary, getModifiedDate, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView
getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup
public static final java.lang.String IT_LINE_ARROW
public static final java.lang.String IT_LINE_DIMENSION
public static final java.lang.String LE_SQUARE
public static final java.lang.String LE_CIRCLE
public static final java.lang.String LE_DIAMOND
public static final java.lang.String LE_OPEN_ARROW
public static final java.lang.String LE_CLOSED_ARROW
public static final java.lang.String LE_NONE
public static final java.lang.String LE_BUTT
public static final java.lang.String LE_R_OPEN_ARROW
public static final java.lang.String LE_R_CLOSED_ARROW
public static final java.lang.String LE_SLASH
public static final java.lang.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(java.lang.String style)
style
- The new style.public java.lang.String getStartPointEndingStyle()
public void setEndPointEndingStyle(java.lang.String style)
style
- The new style.public java.lang.String getEndPointEndingStyle()
public void setInteriorColour(PDGamma ic)
ic
- colour in the DeviceRGB colourspace.public PDGamma getInteriorColour()
public void setCaption(boolean cap)
cap
- Boolean value.public boolean getCaption()
public void setBorderStyle(PDBorderStyleDictionary bs)
bs
- the border style dictionary to set.public PDBorderStyleDictionary getBorderStyle()
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 java.lang.String getCaptionPositioning()
public void setCaptionPositioning(java.lang.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()