Class BorderPainter

java.lang.Object

org.apache.fop.render.intermediate.BorderPainter

Direct Known Subclasses:

AFPPainter.AFPBorderPainterAdapter

public class BorderPainter
extends Object

This is an abstract base class for handling border painting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BorderPainter.AbstractBorderSegment
private static interface	BorderPainter.BorderSegment
private static final class	BorderPainter.Corner
private static enum	BorderPainter.CornerAngles	The four corners SB - Start-Before BE - Before-End EA - End-After AS - After-Start 0 --> x | v y SB BE *----* | | | | *----* AS EA
private static final class	BorderPainter.CornerScaleCorrectionCalculator
private final class	BorderPainter.PathPainter	This is a helper class for constructing curves composed of move, line and arc operations.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	BOTTOM	Convention index of bottom border
protected static final int	BOTTOM_LEFT	Convention index of bottom-left border corners
protected static final int	BOTTOM_RIGHT	Convention index of bottom-right border corners
protected static final float	DASHED_BORDER_LENGTH_FACTOR	The length of the dash as a factor of the border width i.e.
static final float	DASHED_BORDER_SPACE_RATIO	The ratio between a solid dash and the white-space in a dashed-border
private final GraphicsPainter	graphicsPainter
protected static final int	LEFT	Convention index of left border
protected static final int	RIGHT	Convention index of right border
protected static final int	TOP	Convention index of before top
protected static final int	TOP_LEFT	Convention index of top-left border corners
protected static final int	TOP_RIGHT	Convention index of top-right-end border corners

Constructor Summary

Constructors

Constructor	Description
BorderPainter(GraphicsPainter graphicsPainter)

Method Summary

Modifier and Type	Method	Description
private void	arcTo(double startAngle, double endAngle, int cx, int cy, int width, int height)
private static BorderPainter.BorderSegment	borderSegmentForAfter(BorderProps after)
private static BorderPainter.BorderSegment	borderSegmentForBefore(BorderProps before)
private static BorderPainter.BorderSegment	borderSegmentForEnd(BorderProps end)
private static BorderPainter.BorderSegment	borderSegmentForStart(BorderProps start)
protected static double	calculateCornerCorrectionFactor(int width, int height, BorderProps before, BorderProps after, BorderProps start, BorderProps end)	Calculate the correction factor to handle over-sized elliptic corner radii.
protected static double	calculateCornerScaleCorrection(int width, int height, BorderPainter.BorderSegment before, BorderPainter.BorderSegment after, BorderPainter.BorderSegment start, BorderPainter.BorderSegment end)	Calculate the scaling factor to handle over-sized elliptic corner radii.
private void	clip()
void	clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)	Clip the background to the inner border
private void	closePath()
private static int	correctRadius(double cornerCorrectionFactor, int radius)
static float	dashWidthCalculator(float borderLength, float borderWidth)	This method calculates the length of the "dash" in a dashed border.
private void	drawBorderLine(int x1, int y1, int x2, int y2, boolean horz, boolean startOrBefore, int style, Color color)
void	drawBorders(Rectangle borderRect, BorderProps bpsTop, BorderProps bpsBottom, BorderProps bpsLeft, BorderProps bpsRight, Color innerBackgroundColor)	Draws borders.
private void	drawBorderSegment(BorderPainter.BorderSegment start, BorderPainter.BorderSegment before, BorderPainter.BorderSegment end, int orientation, int width, int x, int y, double cornerCorrectionFactor)
protected void	drawRectangularBorders(Rectangle borderRect, BorderProps bpsTop, BorderProps bpsBottom, BorderProps bpsLeft, BorderProps bpsRight)	TODO merge with drawRoundedBorders()?
protected void	drawRoundedBorders(Rectangle borderRect, BorderProps beforeBorderProps, BorderProps afterBorderProps, BorderProps startBorderProps, BorderProps endBorderProps)	TODO merge with drawRectangularBorders?
private double[]	getCornerBorderJoinMetrics(double ellipseCenterX, double ellipseCenterY, double borderWidthRatio)
private double[]	getCornerBorderJoinMetrics(double ellipseCenterX, double ellipseCenterY, double xWidth, double yWidth)
private boolean	isCollapseOuter(BorderProps bp)
private void	lineTo(int x, int y)
private void	moveTo(int x, int y)
private void	restoreGraphicsState()
private void	rotateCoordinates(double angle)
private BorderProps	sanitizeBorderProps(BorderProps bps)
private void	saveGraphicsState()
private void	translateCoordinates(int xTranslate, int yTranslate)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TOP

protected static final int TOP

Convention index of before top

See Also:

• Constant Field Values

RIGHT

protected static final int RIGHT

Convention index of right border

See Also:

• Constant Field Values

BOTTOM

protected static final int BOTTOM

Convention index of bottom border

See Also:

• Constant Field Values

LEFT

protected static final int LEFT

Convention index of left border

See Also:

• Constant Field Values

TOP_LEFT

protected static final int TOP_LEFT

Convention index of top-left border corners

See Also:

• Constant Field Values

TOP_RIGHT

protected static final int TOP_RIGHT

Convention index of top-right-end border corners

See Also:

• Constant Field Values

BOTTOM_RIGHT

protected static final int BOTTOM_RIGHT

Convention index of bottom-right border corners

See Also:

• Constant Field Values

BOTTOM_LEFT

protected static final int BOTTOM_LEFT

Convention index of bottom-left border corners

See Also:

• Constant Field Values

DASHED_BORDER_SPACE_RATIO

public static final float DASHED_BORDER_SPACE_RATIO

The ratio between a solid dash and the white-space in a dashed-border

See Also:

• Constant Field Values

DASHED_BORDER_LENGTH_FACTOR

protected static final float DASHED_BORDER_LENGTH_FACTOR

The length of the dash as a factor of the border width i.e. 2 -> dashWidth = 2*borderWidth

See Also:

• Constant Field Values

graphicsPainter

private final GraphicsPainter graphicsPainter

Constructor Details

BorderPainter

public BorderPainter(GraphicsPainter graphicsPainter)

Method Details

drawBorders

public void drawBorders(Rectangle borderRect,
 BorderProps bpsTop,
 BorderProps bpsBottom,
 BorderProps bpsLeft,
 BorderProps bpsRight,
 Color innerBackgroundColor)
                 throws IFException

Draws borders.

Parameters:

borderRect - the border rectangle

bpsTop - the border specification on the top side

bpsBottom - the border specification on the bottom side

bpsLeft - the border specification on the left side

bpsRight - the border specification on the end side

innerBackgroundColor - the inner background color

Throws:

IFException - if an error occurs while drawing the borders

sanitizeBorderProps

private BorderProps sanitizeBorderProps(BorderProps bps)

drawRectangularBorders

protected void drawRectangularBorders(Rectangle borderRect,
 BorderProps bpsTop,
 BorderProps bpsBottom,
 BorderProps bpsLeft,
 BorderProps bpsRight)
                               throws IOException

TODO merge with drawRoundedBorders()?

Parameters:

borderRect - the border rectangle

bpsTop - the border specification on the top side

bpsBottom - the border specification on the bottom side

bpsLeft - the border specification on the left side

bpsRight - the border specification on the end side

Throws:

IOException

isCollapseOuter

private boolean isCollapseOuter(BorderProps bp)

dashWidthCalculator

public static float dashWidthCalculator(float borderLength,
 float borderWidth)

This method calculates the length of the "dash" in a dashed border. The dash satisfies the condition that corners start on a dash and end with a dash (rather than ending with a white space).

Parameters:

borderLength - The length of the border.

borderWidth - The width/thickness of the border.

Returns:

returns the length of the dash such that it fits the criteria above.

drawRoundedBorders

protected void drawRoundedBorders(Rectangle borderRect,
 BorderProps beforeBorderProps,
 BorderProps afterBorderProps,
 BorderProps startBorderProps,
 BorderProps endBorderProps)
                           throws IOException

TODO merge with drawRectangularBorders?

Parameters:

borderRect - the border rectangle

Throws:

IOException - on io exception

drawBorderSegment

private void drawBorderSegment(BorderPainter.BorderSegment start,
 BorderPainter.BorderSegment before,
 BorderPainter.BorderSegment end,
 int orientation,
 int width,
 int x,
 int y,
 double cornerCorrectionFactor)
                        throws IOException

Throws:

IOException

correctRadius

private static int correctRadius(double cornerCorrectionFactor,
 int radius)

borderSegmentForBefore

private static BorderPainter.BorderSegment borderSegmentForBefore(BorderProps before)

borderSegmentForAfter

private static BorderPainter.BorderSegment borderSegmentForAfter(BorderProps after)

borderSegmentForStart

private static BorderPainter.BorderSegment borderSegmentForStart(BorderProps start)

borderSegmentForEnd

private static BorderPainter.BorderSegment borderSegmentForEnd(BorderProps end)

getCornerBorderJoinMetrics

private double[] getCornerBorderJoinMetrics(double ellipseCenterX,
 double ellipseCenterY,
 double xWidth,
 double yWidth)

getCornerBorderJoinMetrics

private double[] getCornerBorderJoinMetrics(double ellipseCenterX,
 double ellipseCenterY,
 double borderWidthRatio)

clipBackground

public void clipBackground(Rectangle rect,
 BorderProps bpsBefore,
 BorderProps bpsAfter,
 BorderProps bpsStart,
 BorderProps bpsEnd)
                    throws IOException

Clip the background to the inner border

Parameters:

rect - clipping rectangle

bpsBefore - before border

bpsAfter - after border

bpsStart - start border

bpsEnd - end border

Throws:

IOException - if an I/O error occurs

calculateCornerCorrectionFactor

protected static double calculateCornerCorrectionFactor(int width,
 int height,
 BorderProps before,
 BorderProps after,
 BorderProps start,
 BorderProps end)

Calculate the correction factor to handle over-sized elliptic corner radii.

Parameters:

width - the border width

height - the border height

before - the before border properties

after - the after border properties

start - the start border properties

end - the end border properties

calculateCornerScaleCorrection

protected static double calculateCornerScaleCorrection(int width,
 int height,
 BorderPainter.BorderSegment before,
 BorderPainter.BorderSegment after,
 BorderPainter.BorderSegment start,
 BorderPainter.BorderSegment end)

Calculate the scaling factor to handle over-sized elliptic corner radii.

Parameters:

width - the border width

height - the border height

before - the before border segment

after - the after border segment

start - the start border segment

end - the end border segment

drawBorderLine

private void drawBorderLine(int x1,
 int y1,
 int x2,
 int y2,
 boolean horz,
 boolean startOrBefore,
 int style,
 Color color)
                     throws IOException

Throws:

IOException

moveTo

private void moveTo(int x,
 int y)
             throws IOException

Throws:

IOException

lineTo

private void lineTo(int x,
 int y)
             throws IOException

Throws:

IOException

arcTo

private void arcTo(double startAngle,
 double endAngle,
 int cx,
 int cy,
 int width,
 int height)
            throws IOException

Throws:

IOException

rotateCoordinates

private void rotateCoordinates(double angle)
                        throws IOException

Throws:

IOException

translateCoordinates

private void translateCoordinates(int xTranslate,
 int yTranslate)
                           throws IOException

Throws:

IOException

closePath

private void closePath()
                throws IOException

Throws:

IOException

clip

private void clip()
           throws IOException

Throws:

IOException

saveGraphicsState

private void saveGraphicsState()
                        throws IOException

Throws:

IOException

restoreGraphicsState

private void restoreGraphicsState()
                           throws IOException

Throws:

IOException