com.itextpdf.layout.border

Class DashedBorder

java.lang.Object

com.itextpdf.layout.border.Border

com.itextpdf.layout.border.DashedBorder

public class DashedBorder
extends Border

Draws a border with dashes around the element it's been set to.

Nested Class Summary

Nested classes/interfaces inherited from class com.itextpdf.layout.border.Border

Border.Side

Field Summary

Fields inherited from class com.itextpdf.layout.border.Border

_3D_GROOVE, _3D_INSET, _3D_OUTSET, _3D_RIDGE, color, DASHED, DOTTED, DOUBLE, NO_BORDER, ROUND_DOTS, SOLID, type, width

Constructor Summary

Constructors

Constructor and Description
DashedBorder(Color color, float width) Creates a DashedBorder with the specified width and the specified color.
DashedBorder(float width) Creates a DashedBorder with the specified width and sets the color to black.

Method Summary

Modifier and Type	Method and Description
void	draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, float borderWidthBefore, float borderWidthAfter) All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction.
void	drawCellBorder(PdfCanvas canvas, float x1, float y1, float x2, float y2) Draws the border of a cell.
protected float	getDotsGap(double distance, float initialGap) Adjusts the size of the gap between dots
int	getType() Returns the type of the border

Methods inherited from class com.itextpdf.layout.border.Border

equals, getBorderSide, getColor, getWidth, hashCode, setColor, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

DashedBorder

public DashedBorder(float width)

Creates a DashedBorder with the specified width and sets the color to black.

Parameters:

width - width of the border

DashedBorder

public DashedBorder(Color color,
                    float width)

Creates a DashedBorder with the specified width and the specified color.

Parameters:

color - color of the border

width - width of the border

Method Detail

getType

public int getType()

Returns the type of the border

Specified by:

getType in class Border

draw

public void draw(PdfCanvas canvas,
                 float x1,
                 float y1,
                 float x2,
                 float y2,
                 float borderWidthBefore,
                 float borderWidthAfter)

All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction. Borders are drawn in this order: top, right, bottom, left.

Given points specify the line which lies on the border of the content area, therefore the border itself should be drawn to the left from the drawing direction.

borderWidthBefore and borderWidthAfter parameters are used to define the widths of the borders that are before and after the current border, e.g. for the bottom border, borderWidthBefore specifies width of the right border and borderWidthAfter - width of the left border. Those width are used to handle areas of border joins.

Specified by:

draw in class Border

Parameters:

canvas - PdfCanvas to be written to

x1 - x coordinate of the beginning point of the element side, that should be bordered

y1 - y coordinate of the beginning point of the element side, that should be bordered

x2 - x coordinate of the ending point of the element side, that should be bordered

y2 - y coordinate of the ending point of the element side, that should be bordered

borderWidthBefore - defines width of the border that is before the current one

borderWidthAfter - defines width of the border that is after the current one

drawCellBorder

public void drawCellBorder(PdfCanvas canvas,
                           float x1,
                           float y1,
                           float x2,
                           float y2)

Draws the border of a cell.

Specified by:

drawCellBorder in class Border

Parameters:

canvas - PdfCanvas to be written to

x1 - x coordinate of the beginning point of the element side, that should be bordered

y1 - y coordinate of the beginning point of the element side, that should be bordered

x2 - x coordinate of the ending point of the element side, that should be bordered

y2 - y coordinate of the ending point of the element side, that should be bordered

getDotsGap

protected float getDotsGap(double distance,
                           float initialGap)

Adjusts the size of the gap between dots

Parameters:

distance - the border length

initialGap - the initial size of the gap

Returns:

the adjusted size of the gap