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

Modifier and Type	Field and Description
private PDAppearanceHandler	customAppearanceHandler
public static final String	SUB_TYPE The type of annotation.

Access	Constructor and Description
public	PDAnnotationInk() Constructor.
public	PDAnnotationInk(COSDictionary The annotations dictionary. dict) Constructor.

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: An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates. getInkList() Get one or more disjoint paths that make this annotation.
public void	setCustomAppearanceHandler(PDAppearanceHandler custom appearance handler appearanceHandler) Set a custom appearance handler for generating the annotations appearance streams.
public void	setInkList(float[][] An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates. If the parameter is null the entry will be removed. inkList) Sets the paths that make this annotation.

customAppearanceHandler	back to summary
private PDAppearanceHandler customAppearanceHandler

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

PDAnnotationInk	back to summary
public PDAnnotationInk() Constructor.

PDAnnotationInk	back to summary
public PDAnnotationInk(COSDictionary dict) Constructor. Parameters dict:COSDictionary The annotations dictionary.

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

getInkList	back to summary
public float[][] getInkList() Get one or more disjoint paths that make this annotation. Returns:float[][] An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates.

getInkList

back to summary

public float[][] getInkList()

Get one or more disjoint paths that make this annotation.

Returns:float[][]: An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates.

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

setInkList	back to summary
public void setInkList(float[][] inkList) Sets the paths that make this annotation. Parameters inkList:float[][] An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates. If the parameter is null the entry will be removed.

setInkList

back to summary

public void setInkList(float[][] inkList)

Sets the paths that make this annotation.

Parameters

inkList:float[][]: An array of arrays, each representing a stroked path. Each array shall be a series of alternating horizontal and vertical coordinates. If the parameter is null the entry will be removed.

public Class PDAnnotationInk

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail