Class CloudyBorder
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.handlers.CloudyBorder
Generates annotation appearances with a cloudy border.
Dashed stroke styles are not recommended with cloudy borders. The result would not look good because some parts of the arcs are traced twice by the stroked path. Actually Acrobat Reader's line style dialog does not allow to choose a dashed and a cloudy style at the same time.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final double
private static final double
private static final double
private static final double
private static final double
private final PDRectangle
private double
private double
private double
private double
private final double
private final double
private final PDAppearanceContentStream
private boolean
private PDRectangle
-
Constructor Summary
ConstructorsConstructorDescriptionCloudyBorder
(PDAppearanceContentStream stream, double intensity, double lineWidth, PDRectangle rect) Creates a newCloudyBorder
that writes to the specified content stream. -
Method Summary
Modifier and TypeMethodDescriptionprivate 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, double min) private void
beginOutput
(double x, double y) private void
cloudyEllipseImpl
(double leftOrig, double bottomOrig, double rightOrig, double topOrig) Cloudy ellipse implementation.private void
cloudyPolygonImpl
(Point2D.Double[] vertices, boolean 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) (package private) void
Creates a cloudy border for a Circle annotation.(package private) void
createCloudyPolygon
(float[][] path) Creates a cloudy border for a Polygon annotation.(package private) void
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.(package private) PDRectangle
getBBox()
Returns theBBox
entry (bounding box) for the appearance stream form XObject.private double
private Point2D.Double[]
getIntermediateCurlTemplate
(double angleCur, double r) Returns a template for intermediate curls in a cloudy polygon.(package private) AffineTransform
Returns theMatrix
entry for the appearance stream form XObject.private double
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.(package private) PDRectangle
Returns the updatedRect
entry for the annotation.(package private) PDRectangle
Returns the updatedRD
entry for Square and Circle annotations.private void
lineTo
(double x, double y) private void
private void
moveTo
(double x, double y) private void
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)
-
Field Details
-
ANGLE_180_DEG
private static final double ANGLE_180_DEG- See Also:
-
ANGLE_90_DEG
private static final double ANGLE_90_DEG- See Also:
-
ANGLE_34_DEG
private static final double ANGLE_34_DEG -
ANGLE_30_DEG
private static final double ANGLE_30_DEG -
ANGLE_12_DEG
private static final double ANGLE_12_DEG -
output
-
annotRect
-
intensity
private final double intensity -
lineWidth
private final double lineWidth -
rectWithDiff
-
outputStarted
private boolean outputStarted -
bboxMinX
private double bboxMinX -
bboxMinY
private double bboxMinY -
bboxMaxX
private double bboxMaxX -
bboxMaxY
private double bboxMaxY
-
-
Constructor Details
-
CloudyBorder
CloudyBorder(PDAppearanceContentStream stream, double intensity, double lineWidth, PDRectangle rect) Creates a newCloudyBorder
that writes to the specified content stream.- Parameters:
stream
- content streamintensity
- intensity of cloudy effect (entryI
); typically 1.0 or 2.0lineWidth
- line width for annotation border (entryW
)rect
- annotation rectangle (entryRect
)
-
-
Method Details
-
createCloudyRectangle
Creates a cloudy border for a rectangular annotation. The rectangle is specified by theRD
entry and theRect
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
- entryRD
, or null if the entry does not exist- Throws:
IOException
- If there is an error writing to the stream.
-
createCloudyPolygon
Creates a cloudy border for a Polygon annotation.- Parameters:
path
- polygon path- Throws:
IOException
- If there is an error writing to the stream.
-
createCloudyEllipse
Creates a cloudy border for a Circle annotation. The ellipse is specified by theRD
entry and theRect
entry that was passed in to the constructor.- Parameters:
rd
- entryRD
, or null if the entry does not exist- Throws:
IOException
- If there is an error writing to the stream.
-
getBBox
PDRectangle getBBox()Returns theBBox
entry (bounding box) for the appearance stream form XObject.- Returns:
- Bounding box for appearance stream form XObject.
-
getRectangle
PDRectangle getRectangle()Returns the updatedRect
entry for the annotation. The rectangle completely contains the cloudy border.- Returns:
- Annotation
Rect
.
-
getMatrix
AffineTransform getMatrix()Returns theMatrix
entry for the appearance stream form XObject.- Returns:
- Matrix for appearance stream form XObject.
-
getRectDifference
PDRectangle getRectDifference()Returns the updatedRD
entry for Square and Circle annotations.- Returns:
- Annotation
RD
value.
-
cosine
private static double cosine(double dx, double hypot) -
sine
private static double sine(double dy, double hypot) -
cloudyRectangleImpl
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.- Throws:
IOException
-
cloudyPolygonImpl
Cloudy polygon implementation.- Parameters:
vertices
- polygon vertices; first and last point must be equalisEllipse
- specifies if the polygon represents an ellipse- Throws:
IOException
-
computeParamsPolygon
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. -
addCornerCurl
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.- Throws:
IOException
-
addFirstIntermediateCurl
private void addFirstIntermediateCurl(double angleCur, double r, double alpha, double cx, double cy) throws IOException Generates the first intermediate curl for a cloudy polygon.- Throws:
IOException
-
getIntermediateCurlTemplate
Returns a template for intermediate curls in a cloudy polygon.- Throws:
IOException
-
outputCurlTemplate
Writes the curl template points to the output and applies translation (x, y).- Throws:
IOException
-
applyRectDiff
-
reversePolygon
-
getPositivePolygon
Makes a polygon whose direction is the same as the positive angle direction in the coordinate system. The polygon must not intersect itself. -
getPolygonDirection
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". -
getArc
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`.- Throws:
IOException
-
getArcSegment
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`.- Throws:
IOException
-
flattenEllipse
private static Point2D.Double[] flattenEllipse(double left, double bottom, double right, double top) Flattens an ellipse into a polygon. -
cloudyEllipseImpl
private void cloudyEllipseImpl(double leftOrig, double bottomOrig, double rightOrig, double topOrig) throws IOException Cloudy ellipse implementation.- Throws:
IOException
-
computeParamsEllipse
private double computeParamsEllipse(Point2D.Double pt, Point2D.Double ptNext, double r, double curlAdv) Computes the alpha parameter for an ellipse curl. -
removeZeroLengthSegments
-
drawBasicEllipse
private void drawBasicEllipse(double left, double bottom, double right, double top) throws IOException Draws an ellipse without a cloudy border effect.- Throws:
IOException
-
beginOutput
- Throws:
IOException
-
updateBBox
private void updateBBox(double x, double y) -
moveTo
- Throws:
IOException
-
moveTo
- Throws:
IOException
-
lineTo
- Throws:
IOException
-
lineTo
- Throws:
IOException
-
curveTo
private void curveTo(double ax, double ay, double bx, double by, double cx, double cy) throws IOException - Throws:
IOException
-
finish
- Throws:
IOException
-
getEllipseCloudRadius
private double getEllipseCloudRadius() -
getPolygonCloudRadius
private double getPolygonCloudRadius()
-