Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.annotation.handlers.CloudyBorder

Modifier and Type	Field and Description
private static final double	ANGLE_12_DEG
private static final double	ANGLE_180_DEG
private static final double	ANGLE_30_DEG
private static final double	ANGLE_34_DEG
private static final double	ANGLE_90_DEG
private final PDRectangle	annotRect
private double	bboxMaxX
private double	bboxMaxY
private double	bboxMinX
private double	bboxMinY
private final double	intensity
private final double	lineWidth
private final PDAppearanceContentStream	output
private boolean	outputStarted
private PDRectangle	rectWithDiff

Access	Constructor and Description
pack-priv	CloudyBorder(PDAppearanceContentStream content stream stream, double intensity of cloudy effect (entry `I`); typically 1.0 or 2.0 intensity, double line width for annotation border (entry `W`) lineWidth, PDRectangle annotation rectangle (entry `Rect`) rect) Creates a new `CloudyBorder` that writes to the specified content stream.

Method Summary

Modifier and Type	Method and Description
private void	addCornerCurl(double anglePrev, double angleCur, double radius, double cx, double cy, double alpha, double alphaPrev, boolean addMoveTo) Creates a corner curl for polygons and ellipses.
private void	addFirstIntermediateCurl(double angleCur, double r, double alpha, double cx, double cy) Generates the first intermediate curl for a cloudy polygon.
private PDRectangle	applyRectDiff(PDRectangle rd, float min)
private void	beginOutput(double x, double y)
private void	cloudyEllipseImpl(final double leftOrig, final double bottomOrig, final double rightOrig, final double topOrig) Cloudy ellipse implementation.
private void	cloudyPolygonImpl(Point2D.Double[] polygon vertices; first and last point must be equal vertices, boolean specifies if the polygon represents an ellipse isEllipse) Cloudy polygon implementation.
private void	cloudyRectangleImpl(double left, double bottom, double right, double top, boolean isEllipse) Cloudy rectangle implementation is based on converting the rectangle to a polygon.
private double	computeParamsEllipse(Point2D.Double pt, Point2D.Double ptNext, double r, double curlAdv) Computes the alpha parameter for an ellipse curl.
private int	computeParamsPolygon(double advInterm, double advCorner, double k, double r, double length, double[] array) Computes parameters for a cloudy polygon: n, alpha, and dx.
private static double	cosine(double dx, double hypot)
pack-priv void	createCloudyEllipse(PDRectangle entry `RD`, or null if the entry does not exist rd) Creates a cloudy border for a Circle annotation.
pack-priv void	createCloudyPolygon(float[][] polygon path path) Creates a cloudy border for a Polygon annotation.
pack-priv void	createCloudyRectangle(PDRectangle entry `RD`, or null if the entry does not exist rd) Creates a cloudy border for a rectangular annotation.
private void	curveTo(double ax, double ay, double bx, double by, double cx, double cy)
private void	drawBasicEllipse(double left, double bottom, double right, double top) Draws an ellipse without a cloudy border effect.
private void	finish()
private static Point2D.Double[]	flattenEllipse(double left, double bottom, double right, double top) Flattens an ellipse into a polygon.
private void	getArc(double startAng, double endAng, double rx, double ry, double cx, double cy, ArrayList<Point2D.Double> out, boolean addMoveTo) Creates one or more Bézier curves that represent an elliptical arc.
private void	getArcSegment(double startAng, double endAng, double cx, double cy, double rx, double ry, ArrayList<Point2D.Double> out, boolean addMoveTo) Creates a single Bézier curve that represents a section of an elliptical arc.
pack-priv PDRectangle	Returns: Bounding box for appearance stream form XObject. getBBox() Returns the `BBox` entry (bounding box) for the appearance stream form XObject.
private double	getEllipseCloudRadius()
private Point2D.Double[]	getIntermediateCurlTemplate(double angleCur, double r) Returns a template for intermediate curls in a cloudy polygon.
pack-priv AffineTransform	Returns: Matrix for appearance stream form XObject. getMatrix() Returns the `Matrix` entry for the appearance stream form XObject.
private double	getPolygonCloudRadius()
private double	getPolygonDirection(Point2D.Double[] points) Returns the direction of the specified polygon.
private void	getPositivePolygon(Point2D.Double[] points) Makes a polygon whose direction is the same as the positive angle direction in the coordinate system.
pack-priv PDRectangle	Returns: Annotation `Rect`. getRectangle() Returns the updated `Rect` entry for the annotation.
pack-priv PDRectangle	Returns: Annotation `RD` value. getRectDifference() Returns the updated `RD` entry for Square and Circle annotations.
private void	lineTo(Point2D.Double p)
private void	lineTo(double x, double y)
private void	moveTo(Point2D.Double p)
private void	moveTo(double x, double y)
private void	outputCurlTemplate(Point2D.Double[] template, double x, double y) Writes the curl template points to the output and applies translation (x, y).
private Point2D.Double[]	removeZeroLengthSegments(Point2D.Double[] polygon)
private void	reversePolygon(Point2D.Double[] points)
private static double	sine(double dy, double hypot)
private void	updateBBox(double x, double y)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ANGLE_12_DEG	back to summary
private static final double ANGLE_12_DEG

ANGLE_180_DEG	back to summary
private static final double ANGLE_180_DEG

ANGLE_30_DEG	back to summary
private static final double ANGLE_30_DEG

ANGLE_34_DEG	back to summary
private static final double ANGLE_34_DEG

ANGLE_90_DEG	back to summary
private static final double ANGLE_90_DEG

annotRect	back to summary
private final PDRectangle annotRect

bboxMaxX	back to summary
private double bboxMaxX

bboxMaxY	back to summary
private double bboxMaxY

bboxMinX	back to summary
private double bboxMinX

bboxMinY	back to summary
private double bboxMinY

intensity	back to summary
private final double intensity

lineWidth	back to summary
private final double lineWidth

output	back to summary
private final PDAppearanceContentStream output

outputStarted	back to summary
private boolean outputStarted

rectWithDiff	back to summary
private PDRectangle rectWithDiff

CloudyBorder	back to summary
pack-priv CloudyBorder(PDAppearanceContentStream stream, double intensity, double lineWidth, PDRectangle rect) Creates a new `CloudyBorder` that writes to the specified content stream. Parameters stream:PDAppearanceContentStream content stream intensity:double intensity of cloudy effect (entry `I`); typically 1.0 or 2.0 lineWidth:double line width for annotation border (entry `W`) rect:PDRectangle annotation rectangle (entry `Rect`)

Method Detail

addCornerCurl	back to summary
private void addCornerCurl(double anglePrev, double angleCur, double radius, double cx, double cy, double alpha, double alphaPrev, boolean addMoveTo) throws IOException Creates a corner curl for polygons and ellipses.

addFirstIntermediateCurl	back to summary
private void addFirstIntermediateCurl(double angleCur, double r, double alpha, double cx, double cy) throws IOException Generates the first intermediate curl for a cloudy polygon.

applyRectDiff	back to summary
private PDRectangle applyRectDiff(PDRectangle rd, float min)

beginOutput	back to summary
private void beginOutput(double x, double y) throws IOException

cloudyEllipseImpl	back to summary
private void cloudyEllipseImpl(final double leftOrig, final double bottomOrig, final double rightOrig, final double topOrig) throws IOException Cloudy ellipse implementation.

cloudyPolygonImpl	back to summary
private void cloudyPolygonImpl(Point2D.Double[] vertices, boolean isEllipse) throws IOException Cloudy polygon implementation. Parameters vertices:Point2D.Double[] polygon vertices; first and last point must be equal isEllipse:boolean specifies if the polygon represents an ellipse

cloudyPolygonImpl

back to summary

private void cloudyPolygonImpl(Point2D.Double[] vertices, boolean isEllipse) throws IOException

Cloudy polygon implementation.

Parameters

vertices:Point2D.Double[]: polygon vertices; first and last point must be equal
isEllipse:boolean: specifies if the polygon represents an ellipse

cloudyRectangleImpl	back to summary
private void cloudyRectangleImpl(double left, double bottom, double right, double top, boolean isEllipse) throws IOException Cloudy rectangle implementation is based on converting the rectangle to a polygon.

computeParamsEllipse	back to summary
private double computeParamsEllipse(Point2D.Double pt, Point2D.Double ptNext, double r, double curlAdv) Computes the alpha parameter for an ellipse curl.

computeParamsPolygon	back to summary
private int computeParamsPolygon(double advInterm, double advCorner, double k, double r, double length, double[] array) Computes parameters for a cloudy polygon: n, alpha, and dx.

cosine	back to summary
private static double cosine(double dx, double hypot)

createCloudyEllipse back to summary

createCloudyEllipse	back to summary
pack-priv void createCloudyEllipse(PDRectangle rd) throws IOException Creates a cloudy border for a Circle annotation. The ellipse is specified by the `RD` entry and the `Rect` entry that was passed in to the constructor. Parameters rd:PDRectangle entry `RD`, or null if the entry does not exist Exceptions IOException: If there is an error writing to the stream.

pack-priv void createCloudyEllipse(PDRectangle rd) throws IOException

Creates a cloudy border for a Circle annotation. The ellipse is specified by the RD entry and the Rect entry that was passed in to the constructor.

Parameters

rd:PDRectangle: entry RD, or null if the entry does not exist

Exceptions

IOException:: If there is an error writing to the stream.

createCloudyPolygon	back to summary
pack-priv void createCloudyPolygon(float[][] path) throws IOException Creates a cloudy border for a Polygon annotation. Parameters path:float[][] polygon path Exceptions IOException: If there is an error writing to the stream.

createCloudyPolygon

back to summary

pack-priv void createCloudyPolygon(float[][] path) throws IOException

Creates a cloudy border for a Polygon annotation.

Parameters

path:float[][]: polygon path

Exceptions

IOException:: If there is an error writing to the stream.

createCloudyRectangle back to summary

createCloudyRectangle	back to summary
pack-priv void createCloudyRectangle(PDRectangle rd) throws IOException Creates a cloudy border for a rectangular annotation. The rectangle is specified by the `RD` entry and the `Rect` entry that was passed in to the constructor. This can be used for Square and FreeText annotations. However, this does not produce the text and the callout line for FreeTexts. Parameters rd:PDRectangle entry `RD`, or null if the entry does not exist Exceptions IOException: If there is an error writing to the stream.

pack-priv void createCloudyRectangle(PDRectangle rd) throws IOException

Creates a cloudy border for a rectangular annotation. The rectangle is specified by the RD entry and the Rect entry that was passed in to the constructor.

This can be used for Square and FreeText annotations. However, this does not produce the text and the callout line for FreeTexts.

Parameters

rd:PDRectangle: entry RD, or null if the entry does not exist

Exceptions

IOException:: If there is an error writing to the stream.

curveTo	back to summary
private void curveTo(double ax, double ay, double bx, double by, double cx, double cy) throws IOException

drawBasicEllipse	back to summary
private void drawBasicEllipse(double left, double bottom, double right, double top) throws IOException Draws an ellipse without a cloudy border effect.

finish	back to summary
private void finish() throws IOException

flattenEllipse	back to summary
private static Point2D.Double[] flattenEllipse(double left, double bottom, double right, double top) Flattens an ellipse into a polygon.

getArc	back to summary
private void getArc(double startAng, double endAng, double rx, double ry, double cx, double cy, ArrayList<Point2D.Double> out, boolean addMoveTo) throws IOException Creates one or more Bézier curves that represent an elliptical arc. Angles are in radians. The arc will always proceed in the positive angle direction. If the argument `out` is null, this writes the results to the instance variable `output`.

getArc

back to summary

private void getArc(double startAng, double endAng, double rx, double ry, double cx, double cy, ArrayList<Point2D.Double> out, boolean addMoveTo) throws IOException

Creates one or more Bézier curves that represent an elliptical arc. Angles are in radians. The arc will always proceed in the positive angle direction. If the argument `out` is null, this writes the results to the instance variable `output`.

getArcSegment	back to summary
private void getArcSegment(double startAng, double endAng, double cx, double cy, double rx, double ry, ArrayList<Point2D.Double> out, boolean addMoveTo) throws IOException Creates a single Bézier curve that represents a section of an elliptical arc. The sweep angle of the section must not be larger than 90 degrees. If argument `out` is null, this writes the results to the instance variable `output`.

getArcSegment

back to summary

private void getArcSegment(double startAng, double endAng, double cx, double cy, double rx, double ry, ArrayList<Point2D.Double> out, boolean addMoveTo) throws IOException

Creates a single Bézier curve that represents a section of an elliptical arc. The sweep angle of the section must not be larger than 90 degrees. If argument `out` is null, this writes the results to the instance variable `output`.

getBBox back to summary

getBBox	back to summary
pack-priv PDRectangle getBBox() Returns the `BBox` entry (bounding box) for the appearance stream form XObject. Returns:PDRectangle Bounding box for appearance stream form XObject.

pack-priv PDRectangle getBBox()

Returns the BBox entry (bounding box) for the appearance stream form XObject.

Returns:PDRectangle: Bounding box for appearance stream form XObject.

getEllipseCloudRadius	back to summary
private double getEllipseCloudRadius()

getIntermediateCurlTemplate	back to summary
private Point2D.Double[] getIntermediateCurlTemplate(double angleCur, double r) throws IOException Returns a template for intermediate curls in a cloudy polygon.

getMatrix back to summary

getMatrix	back to summary
pack-priv AffineTransform getMatrix() Returns the `Matrix` entry for the appearance stream form XObject. Returns:AffineTransform Matrix for appearance stream form XObject.

pack-priv AffineTransform getMatrix()

Returns the Matrix entry for the appearance stream form XObject.

Returns:AffineTransform: Matrix for appearance stream form XObject.

getPolygonCloudRadius	back to summary
private double getPolygonCloudRadius()

getPolygonDirection	back to summary
private double getPolygonDirection(Point2D.Double[] points) Returns the direction of the specified polygon. A positive value indicates that the polygon's direction is the same as the direction of positive angles in the coordinate system. A negative value indicates the opposite direction. The polygon must not intersect itself. A 2-point polygon is not acceptable. This is based on the "shoelace formula".

getPolygonDirection

back to summary

private double getPolygonDirection(Point2D.Double[] points)

Returns the direction of the specified polygon. A positive value indicates that the polygon's direction is the same as the direction of positive angles in the coordinate system. A negative value indicates the opposite direction. The polygon must not intersect itself. A 2-point polygon is not acceptable. This is based on the "shoelace formula".

getPositivePolygon	back to summary
private void getPositivePolygon(Point2D.Double[] points) Makes a polygon whose direction is the same as the positive angle direction in the coordinate system. The polygon must not intersect itself.

getRectangle back to summary

getRectangle	back to summary
pack-priv PDRectangle getRectangle() Returns the updated `Rect` entry for the annotation. The rectangle completely contains the cloudy border. Returns:PDRectangle Annotation `Rect`.

pack-priv PDRectangle getRectangle()

Returns the updated Rect entry for the annotation. The rectangle completely contains the cloudy border.

Returns:PDRectangle: Annotation Rect.

getRectDifference back to summary

getRectDifference	back to summary
pack-priv PDRectangle getRectDifference() Returns the updated `RD` entry for Square and Circle annotations. Returns:PDRectangle Annotation `RD` value.

pack-priv PDRectangle getRectDifference()

Returns the updated RD entry for Square and Circle annotations.

Returns:PDRectangle: Annotation RD value.

lineTo	back to summary
private void lineTo(Point2D.Double p) throws IOException

lineTo	back to summary
private void lineTo(double x, double y) throws IOException

moveTo	back to summary
private void moveTo(Point2D.Double p) throws IOException

moveTo	back to summary
private void moveTo(double x, double y) throws IOException

outputCurlTemplate	back to summary
private void outputCurlTemplate(Point2D.Double[] template, double x, double y) throws IOException Writes the curl template points to the output and applies translation (x, y).

removeZeroLengthSegments	back to summary
private Point2D.Double[] removeZeroLengthSegments(Point2D.Double[] polygon)

reversePolygon	back to summary
private void reversePolygon(Point2D.Double[] points)

sine	back to summary
private static double sine(double dy, double hypot)

updateBBox	back to summary
private void updateBBox(double x, double y)

pack-priv Class CloudyBorder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail