Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFAnnotationLine

extends FDFAnnotation
Class Inheritance
Imports
java.awt.Color, java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSFloat, .COSName, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine, org.w3c.dom.Element
This represents a Line FDF annotation.
Authors
Ben Litchfield, Johanneke Lamberink

Field Summary

Modifier and TypeField and Description
public static final String
SUBTYPE

COS Model value for SubType entry.

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
annot

Constructor Summary

AccessConstructor and Description
public
FDFAnnotationLine()

Default constructor.

public
FDFAnnotationLine(COSDictionary
An existing FDF Annotation.
a)

Constructor.

public
FDFAnnotationLine(Element
An XFDF element.
element)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

boolean if the content is shown as a caption.
getCaption()

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

public float

Returns:

the horizontal offset of the caption
getCaptionHorizontalOffset()

This will retrieve the horizontal offset of the caption.

public String

Returns:

the caption positioning
getCaptionStyle()

This will retrieve the caption positioning.

public float

Returns:

the vertical offset of the caption
getCaptionVerticalOffset()

This will retrieve the vertical offset of the caption.

public String

Returns:

The ending style for the end point.
getEndPointEndingStyle()

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

public Color

Returns:

object representing the color.
getInteriorColor()

This will retrieve the interior color of the line endings defined in the LE entry.

public float

Returns:

the length of the leader line extensions
getLeaderExtend()

This will retrieve the length of the leader line extensions.

public float

Returns:

the length of the leader line
getLeaderLength()

This will retrieve the length of the leader line.

public float

Returns:

the length of the leader line offset
getLeaderOffset()

This will retrieve the length of the leader line offset.

public float[]

Returns:

array of floats [x1, y1, x2, y2] line start and end points in default user space.
getLine()

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

public String

Returns:

The ending style for the start point.
getStartPointEndingStyle()

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

public final void
setCaption(boolean
Boolean value.
cap)

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

public final void
setCaptionHorizontalOffset(float
the horizontal offset of the caption
offset)

This will set the horizontal offset of the caption.

public final void
setCaptionStyle(String
caption positioning
captionStyle)

This will set the caption positioning.

public final void
setCaptionVerticalOffset(float
vertical offset of the caption
offset)

This will set the vertical offset of the caption.

public final void
setEndPointEndingStyle(String
The new style.
style)

This will set the line ending style for the end point, see the LE_ constants for the possible values.

public final void
setInteriorColor(Color
The interior color of the line endings.
color)

This will set interior color of the line endings defined in the LE entry.

public final void
setLeaderExtend(float
length of the leader line extensions
leaderExtend)

This will set the length of the leader line extensions.

public final void
setLeaderLength(float
length of the leader line
leaderLength)

This will set the length of the leader line.

public final void
setLeaderOffset(float
length of the leader line offset
leaderOffset)

This will set the length of the leader line offset.

public final void
setLine(float[]
array of 4 floats [x1, y1, x2, y2] line start and end points in default user space.
line)

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

public final void
setStartPointEndingStyle(String
The new style.
style)

This will set the line ending style for the start point, see the LE_ constants for the possible values.

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
creategetBorderEffectgetBorderStylegetColorgetContentsgetCOSObjectgetCreationDategetDategetIntentgetNamegetOpacitygetPagegetRectanglegetRichContentsgetStringOrStreamgetSubjectgetTitleisHiddenisInvisibleisLockedisLockedContentsisNoRotateisNoViewisNoZoomisPrintedisReadOnlyisToggleNoViewsetBorderEffectsetBorderStylesetColorsetContentssetCreationDatesetDatesetHiddensetIntentsetInvisiblesetLockedsetLockedContentssetNamesetNoRotatesetNoViewsetNoZoomsetOpacitysetPagesetPrintedsetReadOnlysetRectanglesetRichContentssetSubjectsetTitlesetToggleNoView

Field Detail

SUBTYPEback to summary
public static final String SUBTYPE

COS Model value for SubType entry.

Constructor Detail

FDFAnnotationLineback to summary
public FDFAnnotationLine()

Default constructor.

FDFAnnotationLineback to summary
public FDFAnnotationLine(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationLineback to summary
public FDFAnnotationLine(Element element) throws IOException

Constructor.

Parameters
element:Element

An XFDF element.

Exceptions
IOException:
If there is an error extracting information from the element.

Method Detail

getCaptionback to summary
public boolean getCaption()

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

Returns:boolean

boolean if the content is shown as a caption.

getCaptionHorizontalOffsetback to summary
public float getCaptionHorizontalOffset()

This will retrieve the horizontal offset of the caption.

Returns:float

the horizontal offset of the caption

getCaptionStyleback to summary
public String getCaptionStyle()

This will retrieve the caption positioning.

Returns:String

the caption positioning

getCaptionVerticalOffsetback to summary
public float getCaptionVerticalOffset()

This will retrieve the vertical offset of the caption.

Returns:float

the vertical offset of the caption

getEndPointEndingStyleback to summary
public String getEndPointEndingStyle()

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

Returns:String

The ending style for the end point.

getInteriorColorback to summary
public Color getInteriorColor()

This will retrieve the interior color of the line endings defined in the LE entry.

Returns:Color

object representing the color.

getLeaderExtendback to summary
public float getLeaderExtend()

This will retrieve the length of the leader line extensions.

Returns:float

the length of the leader line extensions

getLeaderLengthback to summary
public float getLeaderLength()

This will retrieve the length of the leader line.

Returns:float

the length of the leader line

getLeaderOffsetback to summary
public float getLeaderOffset()

This will retrieve the length of the leader line offset.

Returns:float

the length of the leader line offset

getLineback to summary
public float[] getLine()

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

Returns:float[]

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

getStartPointEndingStyleback to summary
public String getStartPointEndingStyle()

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

Returns:String

The ending style for the start point.

setCaptionback to summary
public final void setCaption(boolean cap)

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

Parameters
cap:boolean

Boolean value.

setCaptionHorizontalOffsetback to summary
public final void setCaptionHorizontalOffset(float offset)

This will set the horizontal offset of the caption.

Parameters
offset:float

the horizontal offset of the caption

setCaptionStyleback to summary
public final void setCaptionStyle(String captionStyle)

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

Parameters
captionStyle:String

caption positioning

setCaptionVerticalOffsetback to summary
public final void setCaptionVerticalOffset(float offset)

This will set the vertical offset of the caption.

Parameters
offset:float

vertical offset of the caption

setEndPointEndingStyleback to summary
public final 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:String

The new style.

setInteriorColorback to summary
public final void setInteriorColor(Color color)

This will set interior color of the line endings defined in the LE entry.

Parameters
color:Color

The interior color of the line endings.

setLeaderExtendback to summary
public final void setLeaderExtend(float leaderExtend)

This will set the length of the leader line extensions.

Parameters
leaderExtend:float

length of the leader line extensions

setLeaderLengthback to summary
public final void setLeaderLength(float leaderLength)

This will set the length of the leader line.

Parameters
leaderLength:float

length of the leader line

setLeaderOffsetback to summary
public final void setLeaderOffset(float leaderOffset)

This will set the length of the leader line offset.

Parameters
leaderOffset:float

length of the leader line offset

setLineback to summary
public final void setLine(float[] line)

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

Parameters
line:float[]

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

setStartPointEndingStyleback to summary
public final 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:String

The new style.