Package com.itextpdf.layout.borders

Class InsetBorder

java.lang.Object

com.itextpdf.layout.borders.Border

com.itextpdf.layout.borders.Border3D

com.itextpdf.layout.borders.InsetBorder

public class InsetBorder
extends Border3D

Represents a Border3D with an inset effect being applied.

Nested Class Summary

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

Border.Side

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
InsetBorder(float width)	Creates an InsetBorder instance with the specified width.
InsetBorder(DeviceCmyk color, float width)	Creates an InsetBorder instance with the specified width and the cmyk color.
InsetBorder(DeviceCmyk color, float width, float opacity)	Creates an InsetBorder instance with the specified width, color and opacity.
InsetBorder(DeviceGray color, float width)	Creates an InsetBorder instance with the specified width and the gray color.
InsetBorder(DeviceGray color, float width, float opacity)	Creates an InsetBorder instance with the specified width, color and opacity.
InsetBorder(DeviceRgb color, float width)	Creates an InsetBorder instance with the specified width and the rgb color.
InsetBorder(DeviceRgb color, float width, float opacity)	Creates an InsetBorder instance with the specified width, color and opacity.

Method Summary

Modifier and Type	Method	Description
int	getType()	Returns the type of the border
protected void	setInnerHalfColor(PdfCanvas canvas, Border.Side side)	Sets the fill color for the inner half of 3D Border
protected void	setOuterHalfColor(PdfCanvas canvas, Border.Side side)	Sets the fill color for the outer half of 3D Border

Methods inherited from class com.itextpdf.layout.borders.Border3D

draw, drawCellBorder, getDarkerColor

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

draw, draw, draw, drawDiscontinuousBorders, equals, getBorderSide, getColor, getDotsGap, getIntersectionPoint, getOpacity, getStartingPointsForBorderSide, getWidth, hashCode, setColor, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

InsetBorder

public InsetBorder(float width)

Creates an InsetBorder instance with the specified width. The color is set to the predefined gray.

Parameters:

width - width of the border

InsetBorder

public InsetBorder(DeviceRgb color,
                   float width)

Creates an InsetBorder instance with the specified width and the rgb color.

Parameters:

width - width of the border

color - the rgb color of the border

InsetBorder

public InsetBorder(DeviceCmyk color,
                   float width)

Creates an InsetBorder instance with the specified width and the cmyk color.

Parameters:

width - width of the border

color - the cmyk color of the border

InsetBorder

public InsetBorder(DeviceGray color,
                   float width)

Creates an InsetBorder instance with the specified width and the gray color.

Parameters:

width - width of the border

color - the gray color of the border

InsetBorder

public InsetBorder(DeviceRgb color,
                   float width,
                   float opacity)

Creates an InsetBorder instance with the specified width, color and opacity.

Parameters:

color - color of the border

width - width of the border

opacity - opacity of the border

InsetBorder

public InsetBorder(DeviceCmyk color,
                   float width,
                   float opacity)

Creates an InsetBorder instance with the specified width, color and opacity.

Parameters:

color - color of the border

width - width of the border

opacity - opacity of the border

InsetBorder

public InsetBorder(DeviceGray color,
                   float width,
                   float opacity)

Creates an InsetBorder instance with the specified width, color and opacity.

Parameters:

color - color of the border

width - width of the border

opacity - opacity of the border

Method Detail

getType

public int getType()

Returns the type of the border

Specified by:

getType in class Border

Returns:

the type of border.

setInnerHalfColor

protected void setInnerHalfColor(PdfCanvas canvas,
                                 Border.Side side)

Sets the fill color for the inner half of 3D Border

Specified by:

setInnerHalfColor in class Border3D

Parameters:

canvas - PdfCanvas the color will be applied on

side - the side the color will be applied on

setOuterHalfColor

protected void setOuterHalfColor(PdfCanvas canvas,
                                 Border.Side side)

Sets the fill color for the outer half of 3D Border

Specified by:

setOuterHalfColor in class Border3D

Parameters:

canvas - PdfCanvas the color will be applied on

side - the side the color will be applied on