org.pdfbox.pdmodel.interactive.annotation
Class PDAnnotationLine
- COSObjectable
public class PDAnnotationLine
This is the class that represents a line annotation.
Introduced in PDF 1.3 specification
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.
|
boolean | getCaption() - This will retrieve if the contents are shown as a caption or not.
|
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[] | 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 | setCaption(boolean cap) - This will set if the contents are shown as a caption to the line.
|
void | setEndPointEndingStyle(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 | 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 , getInReplyTo , getIntent , getPopup , getReplyType , getRichContents , getSubject , getTitlePopup , setConstantOpacity , setCreationDate , setInReplyTo , setIntent , setPopup , setReplyType , setRichContents , setSubject , setTitlePopup |
createAnnotation , getAction , getActions , getAnnotationFlags , getAnnotationName , getAppearance , getAppearanceStream , getBoderStyle , getCOSObject , getColour , getContents , getDictionary , getModifiedDate , getRectangle , isHidden , isInvisible , isLocked , isNoRotate , isNoView , isNoZoom , isPrinted , isReadOnly , isToggleNoView , setAction , setActions , setAnnotationFlags , setAnnotationName , setAppearance , setAppearanceStream , setBorderStyle , setColour , setContents , setHidden , setInvisible , setLocked , setModifiedDate , setNoRotate , setNoView , setNoZoom , setPrinted , setReadOnly , setRectangle , setToggleNoView |
IT_LINE_ARROW
public static final String IT_LINE_ARROW
Constant for annotation intent of Arrow.
IT_LINE_DIMENSION
public static final String IT_LINE_DIMENSION
Constant for annotation intent of a dimension line.
LE_BUTT
public static final String LE_BUTT
Constant for a butt line ending.
LE_CIRCLE
public static final String LE_CIRCLE
Constant for a circle line ending.
LE_CLOSED_ARROW
public static final String LE_CLOSED_ARROW
Constant for a closed arrow line ending.
LE_DIAMOND
public static final String LE_DIAMOND
Constant for a diamond line ending.
LE_NONE
public static final String LE_NONE
Constant for no line ending.
LE_OPEN_ARROW
public static final String LE_OPEN_ARROW
Constant for a open arrow line ending.
LE_R_CLOSED_ARROW
public static final String LE_R_CLOSED_ARROW
Constant for a revered closed arrow line ending.
LE_R_OPEN_ARROW
public static final String LE_R_OPEN_ARROW
Constant for a reversed open arrow line ending.
LE_SLASH
public static final String LE_SLASH
Constant for a slash line ending.
LE_SQUARE
public static final String LE_SQUARE
Constant for a square line ending.
SUB_TYPE
public static final String SUB_TYPE
The type of annotation.
PDAnnotationLine
public PDAnnotationLine()
Constructor.
PDAnnotationLine
public PDAnnotationLine(COSDictionary field)
Creates a Line annotation from a COSDictionary, expected to be a correct
object definition.
field
- the PDF objet to represent as a field.
getCaption
public boolean getCaption()
This will retrieve if the contents are shown as a caption or not.
- boolean if the content is shown as a caption.
getEndPointEndingStyle
public String getEndPointEndingStyle()
This will retrieve the line ending style for the end point,
possible values shown in the LE_ constants section.
- The ending style for the end point.
getInteriorColour
public PDGamma getInteriorColour()
This will retrieve the interior colour of the line endings defined in the
LE entry. Colour is in DeviceRGB colourspace.
- PDGamma object representing the colour.
getLine
public float[] getLine()
This will retrieve the start and end coordinates of the line (or leader
line if LL entry is set).
- array of floats [x1, y1, x2, y2] line start and end points in
default user space.
getStartPointEndingStyle
public String getStartPointEndingStyle()
This will retrieve the line ending style for the start point,
possible values shown in the LE_ constants section.
- The ending style for the start point.
setCaption
public void setCaption(boolean cap)
This will set if the contents are shown as a caption to the line.
setEndPointEndingStyle
public void setEndPointEndingStyle(String style)
This will set the line ending style for the end point,
see the LE_ constants for the possible values.
setInteriorColour
public void setInteriorColour(PDGamma ic)
This will set interior colour of the line endings defined in the LE
entry. Colour is in DeviceRGB colourspace.
ic
- colour in the DeviceRGB colourspace.
setLine
public void setLine(float[] l)
This will set start and end coordinates of the line (or leader line if LL
entry is set).
l
- array of 4 floats [x1, y1, x2, y2] line start and end points
in default user space.
setStartPointEndingStyle
public void setStartPointEndingStyle(String style)
This will set the line ending style for the start point,
see the LE_ constants for the possible values.