Top Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.annotation

public Class PDAnnotationPolyline

extends PDAnnotationMarkup
Class Inheritance
Imports
org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.graphics.color.PDColor, org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAppearanceHandler, .PDPolylineAppearanceHandler
Author
Paul King

Field Summary

Modifier and TypeField and Description
private PDAppearanceHandler
customAppearanceHandler

public static final String
SUB_TYPE

The type of annotation.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
RT_GROUPRT_REPLY

Constructor Summary

AccessConstructor and Description
public
PDAnnotationPolyline()

Constructor.

public
PDAnnotationPolyline(COSDictionary
The annotations dictionary.
dict)

Constructor.

Method Summary

Modifier and TypeMethod 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 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 with which to fill the annotation’s line endings.

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 float[]

Returns:

An array of floats representing the alternating horizontal and vertical coordinates.
getVertices()

This will retrieve the numbers that shall represent the alternating horizontal and vertical coordinates.

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.
ic)

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

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.

public void
setVertices(float[]
an array with the numbers that shall represent the alternating horizontal and vertical coordinates.
points)

This will set the numbers that shall represent the alternating horizontal and vertical coordinates.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
getBorderStylegetConstantOpacitygetCreationDategetExternalDatagetInReplyTogetIntentgetPopupgetReplyTypegetRichContentsgetSubjectgetTitlePopupsetBorderStylesetConstantOpacitysetCreationDatesetExternalDatasetInReplyTosetIntentsetPopupsetReplyTypesetRichContentssetSubjectsetTitlePopup

Field Detail

customAppearanceHandlerback to summary
private PDAppearanceHandler customAppearanceHandler
SUB_TYPEback to summary
public static final String SUB_TYPE

The type of annotation.

Constructor Detail

PDAnnotationPolylineback to summary
public PDAnnotationPolyline()

Constructor.

PDAnnotationPolylineback to summary
public PDAnnotationPolyline(COSDictionary dict)

Constructor.

Parameters
dict:COSDictionary

The annotations dictionary.

Method Detail

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

getInteriorColorback to summary
public PDColor getInteriorColor()

This will retrieve the interior color with which to fill the annotation’s line endings.

Returns:PDColor

object representing the color.

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

getVerticesback to summary
public float[] getVertices()

This will retrieve the numbers that shall represent the alternating horizontal and vertical coordinates.

Returns:float[]

An array of floats representing the alternating horizontal and vertical coordinates.

setCustomAppearanceHandlerback to summary
public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)

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

Parameters
appearanceHandler:PDAppearanceHandler

custom appearance handler

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

setInteriorColorback to summary
public void setInteriorColor(PDColor ic)

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

Parameters
ic:PDColor

color.

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

setVerticesback to summary
public void setVertices(float[] points)

This will set the numbers that shall represent the alternating horizontal and vertical coordinates.

Parameters
points:float[]

an array with the numbers that shall represent the alternating horizontal and vertical coordinates.