org.apache.pdfbox.pdmodel.interactive.annotation
Class PDAnnotationLine

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

public class PDAnnotationLine
extends PDAnnotationMarkup

This is the class that represents a line annotation. Introduced in PDF 1.3 specification

Version:

$Revision: 1.1 $

Author:

Paul King

Field Summary

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.

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

FLAG_HIDDEN, FLAG_INVISIBLE, FLAG_LOCKED, FLAG_NO_ROTATE, FLAG_NO_VIEW, FLAG_NO_ZOOM, FLAG_PRINTED, FLAG_READ_ONLY, FLAG_TOGGLE_NO_VIEW

Constructor Summary

PDAnnotationLine()
Constructor.

PDAnnotationLine(COSDictionary field)
Creates a Line annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

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.
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).
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	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(String style) This will set the line ending style for the start point, see the LE_ constants for the possible values.

Methods inherited from class 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 inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

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, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IT_LINE_ARROW

public static final String IT_LINE_ARROW

Constant for annotation intent of Arrow.

See Also:

Constant Field Values

IT_LINE_DIMENSION

public static final String IT_LINE_DIMENSION

Constant for annotation intent of a dimension line.

See Also:

Constant Field Values

LE_SQUARE

public static final String LE_SQUARE

Constant for a square line ending.

See Also:

Constant Field Values

LE_CIRCLE

public static final String LE_CIRCLE

Constant for a circle line ending.

See Also:

Constant Field Values

LE_DIAMOND

public static final String LE_DIAMOND

Constant for a diamond line ending.

See Also:

Constant Field Values

LE_OPEN_ARROW

public static final String LE_OPEN_ARROW

Constant for a open arrow line ending.

See Also:

Constant Field Values

LE_CLOSED_ARROW

public static final String LE_CLOSED_ARROW

Constant for a closed arrow line ending.

See Also:

Constant Field Values

LE_NONE

public static final String LE_NONE

Constant for no line ending.

See Also:

Constant Field Values

LE_BUTT

public static final String LE_BUTT

Constant for a butt line ending.

See Also:

Constant Field Values

LE_R_OPEN_ARROW

public static final String LE_R_OPEN_ARROW

Constant for a reversed open arrow line ending.

See Also:

Constant Field Values

LE_R_CLOSED_ARROW

public static final String LE_R_CLOSED_ARROW

Constant for a revered closed arrow line ending.

See Also:

Constant Field Values

LE_SLASH

public static final String LE_SLASH

Constant for a slash line ending.

See Also:

Constant Field Values

SUB_TYPE

public static final String SUB_TYPE

The type of annotation.

See Also:

Constant Field Values

Constructor Detail

PDAnnotationLine

public PDAnnotationLine()

Constructor.

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 Detail

setLine

public void setLine(float[] l)

This will set start and end coordinates of the line (or leader line if LL entry is set).

Parameters:

l - array of 4 floats [x1, y1, x2, y2] line start and end points in default user space.

getLine

public float[] getLine()

This will retrieve the start and end coordinates of the line (or leader line if LL entry is set).

Returns:

array of 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.

Parameters:

style - The new style.

getStartPointEndingStyle

public String getStartPointEndingStyle()

This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.

Returns:

The ending style for the start point.

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.

Parameters:

style - The new style.

getEndPointEndingStyle

public String getEndPointEndingStyle()

This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.

Returns:

The ending style for the end point.

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.

Parameters:

ic - colour in the DeviceRGB colourspace.

getInteriorColour

public PDGamma getInteriorColour()

This will retrieve the interior colour of the line endings defined in the LE entry. Colour is in DeviceRGB colourspace.

Returns:

PDGamma object representing the colour.

setCaption

public void setCaption(boolean cap)

This will set if the contents are shown as a caption to the line.

Parameters:

cap - Boolean value.

getCaption

public boolean getCaption()

This will retrieve if the contents are shown as a caption or not.

Returns:

boolean if the content is shown as a caption.

setBorderStyle

public void setBorderStyle(PDBorderStyleDictionary bs)

This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.

Parameters:

bs - the border style dictionary to set.

getBorderStyle

public PDBorderStyleDictionary getBorderStyle()

This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.

Returns:

the border style dictionary.

getLeaderLineLength

public float getLeaderLineLength()

This will retrieve the length of the leader line.

Returns:

the length of the leader line

setLeaderLineLength

public void setLeaderLineLength(float leaderLineLength)

This will set the length of the leader line.

Parameters:

leaderLineLength - length of the leader line

getLeaderLineExtensionLength

public float getLeaderLineExtensionLength()

This will retrieve the length of the leader line extensions.

Returns:

the length of the leader line extensions

setLeaderLineExtensionLength

public void setLeaderLineExtensionLength(float leaderLineExtensionLength)

This will set the length of the leader line extensions.

Parameters:

leaderLineExtensionLength - length of the leader line extensions

getLeaderLineOffsetLength

public float getLeaderLineOffsetLength()

This will retrieve the length of the leader line offset.

Returns:

the length of the leader line offset

setLeaderLineOffsetLength

public void setLeaderLineOffsetLength(float leaderLineOffsetLength)

This will set the length of the leader line offset.

Parameters:

leaderLineOffsetLength - length of the leader line offset

getCaptionPositioning

public String getCaptionPositioning()

This will retrieve the caption positioning.

Returns:

the caption positioning

setCaptionPositioning

public void setCaptionPositioning(String captionPositioning)

This will set the caption positioning. Allowed values are: "Inline" and "Top"

Parameters:

captionPositioning - caption positioning

setCaptionHorizontalOffset

public void setCaptionHorizontalOffset(float offset)

This will set the horizontal offset of the caption.

Parameters:

offset - the horizontal offset of the caption

getCaptionHorizontalOffset

public float getCaptionHorizontalOffset()

This will retrieve the horizontal offset of the caption.

Returns:

the the horizontal offset of the caption

setCaptionVerticalOffset

public void setCaptionVerticalOffset(float offset)

This will set the vertical offset of the caption.

Parameters:

offset - vertical offset of the caption

getCaptionVerticalOffset

public float getCaptionVerticalOffset()

This will retrieve the vertical offset of the caption.

Returns:

the vertical offset of the caption