Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine

Field Summary

Modifier and Type	Field and Description
private PDAppearanceHandler	customAppearanceHandler
public static final String	IT_LINE_ARROW Constant for annotation intent of Arrow.
public static final String	IT_LINE_DIMENSION Constant for annotation intent of a dimension line.
public static final String	LE_BUTT Constant for a butt line ending.
public static final String	LE_CIRCLE Constant for a circle line ending.
public static final String	LE_CLOSED_ARROW Constant for a closed arrow line ending.
public static final String	LE_DIAMOND Constant for a diamond line ending.
public static final String	LE_NONE Constant for no line ending.
public static final String	LE_OPEN_ARROW Constant for a open arrow line ending.
public static final String	LE_R_CLOSED_ARROW Constant for a reversed closed arrow line ending.
public static final String	LE_R_OPEN_ARROW Constant for a reversed open arrow line ending.
public static final String	LE_SLASH Constant for a slash line ending.
public static final String	LE_SQUARE Constant for a square line ending.
public static final String	SUB_TYPE The type of annotation.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:: RT_GROUP RT_REPLY

Constructor Summary

Access	Constructor and Description
public	PDAnnotationLine() Constructor.
public	PDAnnotationLine(COSDictionary the PDF object to represent as a field. field) Creates a Line annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Modifier and Type	Method and Description
public void	constructAppearances() Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Create the appearance entry for this annotation.
public void	constructAppearances(PDDocument the related document document) Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Create the appearance entry for this annotation.
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 getCaptionPositioning() 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, LE_NONE if missing, never null. getEndPointEndingStyle() This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
public PDColor	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 getLeaderLineExtensionLength() This will retrieve the length of the leader line extensions.
public float	Returns: the length of the leader line getLeaderLineLength() This will retrieve the length of the leader line.
public float	Returns: the length of the leader line offset getLeaderLineOffsetLength() 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, LE_NONE if missing, never null. getStartPointEndingStyle() This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
public boolean	Returns: boolean if the contents shall be shown as a caption (default: false). hasCaption() This will retrieve whether the text specified by the /Contents or /RC entries shall be shown as a caption in the appearance of the line.
public void	setCaption(boolean Boolean value. cap) This will set if the contents are shown as a caption to the line.
public void	setCaptionHorizontalOffset(float the horizontal offset of the caption offset) This will set the horizontal offset of the caption.
public void	setCaptionPositioning(String caption positioning captionPositioning) This will set the caption positioning.
public void	setCaptionVerticalOffset(float vertical offset of the caption offset) This will set the vertical offset of the caption.
public void	setCustomAppearanceHandler(PDAppearanceHandler custom appearance handler appearanceHandler) Set a custom appearance handler for generating the annotations appearance streams.
public 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 void	setInteriorColor(PDColor color in the DeviceRGB color space. ic) This will set interior color of the line endings defined in the LE entry.
public void	setLeaderLineExtensionLength(float length of the leader line extensions leaderLineExtensionLength) This will set the length of the leader line extensions.
public void	setLeaderLineLength(float length of the leader line leaderLineLength) This will set the length of the leader line.
public void	setLeaderLineOffsetLength(float length of the leader line offset leaderLineOffsetLength) This will set the length of the leader line offset.
public void	setLine(float[] array of 4 floats [x1, y1, x2, y2] line start and end points in default user space. l) This will set start and end coordinates of the line (or leader line if LL entry is set).
public 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.

Field Detail

customAppearanceHandler	back to summary
private PDAppearanceHandler customAppearanceHandler

IT_LINE_ARROW	back to summary
public static final String IT_LINE_ARROW Constant for annotation intent of Arrow.

IT_LINE_DIMENSION	back to summary
public static final String IT_LINE_DIMENSION Constant for annotation intent of a dimension line.

LE_BUTT	back to summary
public static final String LE_BUTT Constant for a butt line ending.

LE_CIRCLE	back to summary
public static final String LE_CIRCLE Constant for a circle line ending.

LE_CLOSED_ARROW	back to summary
public static final String LE_CLOSED_ARROW Constant for a closed arrow line ending.

LE_DIAMOND	back to summary
public static final String LE_DIAMOND Constant for a diamond line ending.

LE_NONE	back to summary
public static final String LE_NONE Constant for no line ending.

LE_OPEN_ARROW	back to summary
public static final String LE_OPEN_ARROW Constant for a open arrow line ending.

LE_R_CLOSED_ARROW	back to summary
public static final String LE_R_CLOSED_ARROW Constant for a reversed closed arrow line ending.

LE_R_OPEN_ARROW	back to summary
public static final String LE_R_OPEN_ARROW Constant for a reversed open arrow line ending.

LE_SLASH	back to summary
public static final String LE_SLASH Constant for a slash line ending.

LE_SQUARE	back to summary
public static final String LE_SQUARE Constant for a square line ending.

SUB_TYPE	back to summary
public static final String SUB_TYPE The type of annotation.

Constructor Detail

PDAnnotationLine	back to summary
public PDAnnotationLine() Constructor.

PDAnnotationLine	back to summary
public PDAnnotationLine(COSDictionary field) Creates a Line annotation from a COSDictionary, expected to be a correct object definition. Parameters field:COSDictionary the PDF object to represent as a field.

PDAnnotationLine

back to summary

public PDAnnotationLine(COSDictionary field)

Creates a Line annotation from a COSDictionary, expected to be a correct object definition.

Parameters

field:COSDictionary: the PDF object to represent as a field.

Method Detail

constructAppearances	back to summary
public void constructAppearances() Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing. Annotations @Override

constructAppearances

back to summary

public void constructAppearances()

Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Annotations

@Override

constructAppearances	back to summary
public void constructAppearances(PDDocument document) Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances. Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing. Parameters document:PDDocument the related document Annotations @Override

constructAppearances

back to summary

public void constructAppearances(PDDocument document)

Overrides org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Doc from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation.constructAppearances.

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Parameters

document:PDDocument: the related document

Annotations

@Override

getCaptionHorizontalOffset	back to summary
public float getCaptionHorizontalOffset() This will retrieve the horizontal offset of the caption. Returns:float the horizontal offset of the caption

getCaptionHorizontalOffset

back to summary

public float getCaptionHorizontalOffset()

This will retrieve the horizontal offset of the caption.

Returns:float: the horizontal offset of the caption

getCaptionPositioning	back to summary
public String getCaptionPositioning() This will retrieve the caption positioning. Returns:String the caption positioning

getCaptionPositioning

back to summary

public String getCaptionPositioning()

This will retrieve the caption positioning.

Returns:String: the caption positioning

getCaptionVerticalOffset	back to summary
public float getCaptionVerticalOffset() This will retrieve the vertical offset of the caption. Returns:float the vertical offset of the caption

getCaptionVerticalOffset

back to summary

public float getCaptionVerticalOffset()

This will retrieve the vertical offset of the caption.

Returns:float: the vertical offset of the caption

getEndPointEndingStyle	back 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, LE_NONE if missing, never null.

getEndPointEndingStyle

back 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, LE_NONE if missing, never null.

getInteriorColor	back to summary
public PDColor getInteriorColor() This will retrieve the interior color of the line endings defined in the LE entry. color is in DeviceRGB color space. Returns:PDColor object representing the color.

getInteriorColor

back to summary

public PDColor getInteriorColor()

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

Returns:PDColor: object representing the color.

getLeaderLineExtensionLength	back to summary
public float getLeaderLineExtensionLength() This will retrieve the length of the leader line extensions. Returns:float the length of the leader line extensions

getLeaderLineExtensionLength

back to summary

public float getLeaderLineExtensionLength()

This will retrieve the length of the leader line extensions.

Returns:float: the length of the leader line extensions

getLeaderLineLength	back to summary
public float getLeaderLineLength() This will retrieve the length of the leader line. Returns:float the length of the leader line

getLeaderLineLength

back to summary

public float getLeaderLineLength()

This will retrieve the length of the leader line.

Returns:float: the length of the leader line

getLeaderLineOffsetLength	back to summary
public float getLeaderLineOffsetLength() This will retrieve the length of the leader line offset. Returns:float the length of the leader line offset

getLeaderLineOffsetLength

back to summary

public float getLeaderLineOffsetLength()

This will retrieve the length of the leader line offset.

Returns:float: the length of the leader line offset

getLine	back 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.

getLine

back 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.

getStartPointEndingStyle	back 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, LE_NONE if missing, never null.

getStartPointEndingStyle

back 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, LE_NONE if missing, never null.

hasCaption	back to summary
public boolean hasCaption() This will retrieve whether the text specified by the /Contents or /RC entries shall be shown as a caption in the appearance of the line. Returns:boolean boolean if the contents shall be shown as a caption (default: false).

hasCaption

back to summary

public boolean hasCaption()

This will retrieve whether the text specified by the /Contents or /RC entries shall be shown as a caption in the appearance of the line.

Returns:boolean: boolean if the contents shall be shown as a caption (default: false).

setCaption	back to summary
public void setCaption(boolean cap) This will set if the contents are shown as a caption to the line. Parameters cap:boolean Boolean value.

setCaption

back to summary

public void setCaption(boolean cap)

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

Parameters

cap:boolean: Boolean value.

setCaptionHorizontalOffset	back to summary
public void setCaptionHorizontalOffset(float offset) This will set the horizontal offset of the caption. Parameters offset:float the horizontal offset of the caption

setCaptionHorizontalOffset

back to summary

public void setCaptionHorizontalOffset(float offset)

This will set the horizontal offset of the caption.

Parameters

offset:float: the horizontal offset of the caption

setCaptionPositioning	back to summary
public void setCaptionPositioning(String captionPositioning) This will set the caption positioning. Allowed values are: "Inline" and "Top" Parameters captionPositioning:String caption positioning

setCaptionPositioning

back to summary

public void setCaptionPositioning(String captionPositioning)

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

Parameters

captionPositioning:String: caption positioning

setCaptionVerticalOffset	back to summary
public void setCaptionVerticalOffset(float offset) This will set the vertical offset of the caption. Parameters offset:float vertical offset of the caption

setCaptionVerticalOffset

back to summary

public void setCaptionVerticalOffset(float offset)

This will set the vertical offset of the caption.

Parameters

offset:float: vertical offset of the caption

setCustomAppearanceHandler	back to summary
public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler) Set a custom appearance handler for generating the annotations appearance streams. Parameters appearanceHandler:PDAppearanceHandler custom appearance handler

setCustomAppearanceHandler

back to summary

public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)

Set a custom appearance handler for generating the annotations appearance streams.

Parameters

appearanceHandler:PDAppearanceHandler: custom appearance handler

setEndPointEndingStyle	back to summary
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:String The new style.

setEndPointEndingStyle

back to summary

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:String: The new style.

setInteriorColor	back to summary
public void setInteriorColor(PDColor ic) This will set interior color of the line endings defined in the LE entry. color is in DeviceRGB color space. Parameters ic:PDColor color in the DeviceRGB color space.

setInteriorColor

back to summary

public void setInteriorColor(PDColor ic)

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

Parameters

ic:PDColor: color in the DeviceRGB color space.

setLeaderLineExtensionLength	back to summary
public void setLeaderLineExtensionLength(float leaderLineExtensionLength) This will set the length of the leader line extensions. Parameters leaderLineExtensionLength:float length of the leader line extensions

setLeaderLineExtensionLength

back to summary

public void setLeaderLineExtensionLength(float leaderLineExtensionLength)

This will set the length of the leader line extensions.

Parameters

leaderLineExtensionLength:float: length of the leader line extensions

setLeaderLineLength	back to summary
public void setLeaderLineLength(float leaderLineLength) This will set the length of the leader line. Parameters leaderLineLength:float length of the leader line

setLeaderLineLength

back to summary

public void setLeaderLineLength(float leaderLineLength)

This will set the length of the leader line.

Parameters

leaderLineLength:float: length of the leader line

setLeaderLineOffsetLength	back to summary
public void setLeaderLineOffsetLength(float leaderLineOffsetLength) This will set the length of the leader line offset. Parameters leaderLineOffsetLength:float length of the leader line offset

setLeaderLineOffsetLength

back to summary

public void setLeaderLineOffsetLength(float leaderLineOffsetLength)

This will set the length of the leader line offset.

Parameters

leaderLineOffsetLength:float: length of the leader line offset

setLine	back to summary
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:float[] array of 4 floats [x1, y1, x2, y2] line start and end points in default user space.

setLine

back to summary

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:float[]: array of 4 floats [x1, y1, x2, y2] line start and end points in default user space.

setStartPointEndingStyle	back to summary
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:String The new style.

setStartPointEndingStyle

back to summary

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:String: The new style.

public Class PDAnnotationLine

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail