com.lowagie.text.rtf.table

Class RtfBorder

public class RtfBorder extends RtfElement

The RtfBorder handle one row or cell border. INTERNAL USE ONLY

Version: $Version:$

Author: Mark Hall (mhall@edu.uni-klu.ac.at)

Field Summary
RtfColorborderColor
The colour of this RtfBorder
intborderPosition
The position of this RtfBorder
intborderStyle
The style of this RtfBorder
intborderType
The type of this RtfBorder
intborderWidth
The width of this RtfBorder
protected static byte[]BORDER_COLOR_NUMBER
Constant for the border colour number
static intBORDER_DASHED
Constant for a dashed border
static intBORDER_DOTTED
Constant for a dotted border
static intBORDER_DOT_DASH
Constant for a dot dash border
static intBORDER_DOT_DOT_DASH
Constant for a dot dot dash border
static intBORDER_DOUBLE
Constant for a double border
static intBORDER_DOUBLE_THICK
Constant for a double thick border
static intBORDER_DOUBLE_WAVY
Constant for a double wavy border
static intBORDER_EMBOSS
Constant for an embossed border
static intBORDER_ENGRAVE
Constant for an engraved border
static intBORDER_HAIRLINE
Constant for a hairline border
static intBORDER_NONE
Constant for a border with no border
static intBORDER_SHADOWED
Constant for a shadowed border
static intBORDER_SINGLE
Constant for a single border
static intBORDER_STRIPED
Constant for a striped border
protected static byte[]BORDER_STYLE_DASHED
Constant for the dashed border style
protected static byte[]BORDER_STYLE_DOTTED
Constant for the dotted border style
protected static byte[]BORDER_STYLE_DOT_DASH
Constant for the dot dash border style
protected static byte[]BORDER_STYLE_DOT_DOT_DASH
Constant for the dot dot dash border style
protected static byte[]BORDER_STYLE_DOUBLE
Constant for the double border style
protected static byte[]BORDER_STYLE_DOUBLE_THICK
Constant for the double thick border style
protected static byte[]BORDER_STYLE_DOUBLE_WAVY
Constant for the double wavy border style
protected static byte[]BORDER_STYLE_EMBOSS
Constant for the embossed border style
protected static byte[]BORDER_STYLE_ENGRAVE
Constant for the engraved border style
protected static byte[]BORDER_STYLE_HAIRLINE
Constant for the hairline border style
protected static byte[]BORDER_STYLE_SHADOWED
Constant for the shadowed border style
protected static byte[]BORDER_STYLE_SINGLE
Constant for the single border style
protected static byte[]BORDER_STYLE_STRIPED
Constant for the striped border style
protected static byte[]BORDER_STYLE_THICK_THIN
Constant for the thick thin border style
protected static byte[]BORDER_STYLE_THICK_THIN_LARGE
Constant for the thick thin large border style
protected static byte[]BORDER_STYLE_THICK_THIN_MED
Constant for the thick thin medium border style
protected static byte[]BORDER_STYLE_THIN_THICK
Constant for the thin thick border style
protected static byte[]BORDER_STYLE_THIN_THICK_LARGE
Constant for the thin thick large border style
protected static byte[]BORDER_STYLE_THIN_THICK_MED
Constant for the thin thick medium border style
protected static byte[]BORDER_STYLE_THIN_THICK_THIN
Constant for the thin thick thin border style
protected static byte[]BORDER_STYLE_THIN_THICK_THIN_LARGE
Constant for the thin thick thin large border style
protected static byte[]BORDER_STYLE_THIN_THICK_THIN_MED
Constant for the thin thick thin medium border style
protected static byte[]BORDER_STYLE_TRIPLE
Constant for the triple border style
protected static byte[]BORDER_STYLE_WAVY
Constant for the wavy border style
static intBORDER_THICK_THIN
Constant for a thick thin border
static intBORDER_THICK_THIN_LARGE
Constant for a thick thin large border
static intBORDER_THICK_THIN_MED
Constant for a thick thin medium border
static intBORDER_THIN_THICK
Constant for a thin thick border
static intBORDER_THIN_THICK_LARGE
Constant for a thin thick large border
static intBORDER_THIN_THICK_MED
Constant for a thin thick medium border
static intBORDER_THIN_THICK_THIN
Constant for a thin thick thin border
static intBORDER_THIN_THICK_THIN_LARGE
Constant for a thin thick thin large border
static intBORDER_THIN_THICK_THIN_MED
Constant for a thin thick thin medium border
static intBORDER_TRIPLE
Constant for a triple border
static intBORDER_WAVY
Constant for a wavy border
protected static byte[]BORDER_WIDTH
Constant for the border width
protected static intBOTTOM_BORDER
Constant for a bottom border
protected static intBOX_BORDER
Constant for a box (left, top, right, bottom) border
protected static intCELL_BORDER
Constant for a cell border
protected static byte[]CELL_BORDER_BOTTOM
Constant for the bottom cell border
protected static byte[]CELL_BORDER_LEFT
Constant for the left cell border
protected static byte[]CELL_BORDER_RIGHT
Constant for the right cell border
protected static byte[]CELL_BORDER_TOP
Constant for the top cell border
protected static intHORIZONTAL_BORDER
Constant for a horizontal line
protected static intLEFT_BORDER
Constant for a left border
protected static intNO_BORDER
This border is no border :-)
protected static intRIGHT_BORDER
Constant for a right border
protected static intROW_BORDER
Constant for a row border
protected static byte[]ROW_BORDER_BOTTOM
Constant for the bottom row border
protected static byte[]ROW_BORDER_HORIZONTAL
Constant for the horizontal line
protected static byte[]ROW_BORDER_LEFT
Constant for the left row border
protected static byte[]ROW_BORDER_RIGHT
Constant for the right row border
protected static byte[]ROW_BORDER_TOP
Constant for the top row border
protected static byte[]ROW_BORDER_VERTICAL
Constant for the vertical line
protected static intTOP_BORDER
Constant for a top border
protected static intVERTICAL_BORDER
Constant for a vertical line
Constructor Summary
protected RtfBorder(RtfDocument doc, int borderType, RtfBorder border)
Makes a copy of the given RtfBorder
protected RtfBorder(RtfDocument doc, int borderType, int borderPosition, int borderStyle, float borderWidth, Color borderColor)
Constructs a RtfBorder
Method Summary
protected RtfColorgetBorderColor()
Gets the colour of this RtfBorder
protected intgetBorderPosition()
Gets the position of this RtfBorder
protected intgetBorderStyle()
Gets the style of this RtfBorder
protected intgetBorderType()
Gets the type of this RtfBorder
protected intgetBorderWidth()
Gets the width of this RtfBorder
byte[]write()
Writes the RtfBorder settings
byte[]writeBorderStyle()
Writes the style of this RtfBorder

Field Detail

borderColor

private RtfColor borderColor
The colour of this RtfBorder

borderPosition

private int borderPosition
The position of this RtfBorder

borderStyle

private int borderStyle
The style of this RtfBorder

borderType

private int borderType
The type of this RtfBorder

borderWidth

private int borderWidth
The width of this RtfBorder

BORDER_COLOR_NUMBER

protected static final byte[] BORDER_COLOR_NUMBER
Constant for the border colour number

BORDER_DASHED

public static final int BORDER_DASHED
Constant for a dashed border

BORDER_DOTTED

public static final int BORDER_DOTTED
Constant for a dotted border

BORDER_DOT_DASH

public static final int BORDER_DOT_DASH
Constant for a dot dash border

BORDER_DOT_DOT_DASH

public static final int BORDER_DOT_DOT_DASH
Constant for a dot dot dash border

BORDER_DOUBLE

public static final int BORDER_DOUBLE
Constant for a double border

BORDER_DOUBLE_THICK

public static final int BORDER_DOUBLE_THICK
Constant for a double thick border

BORDER_DOUBLE_WAVY

public static final int BORDER_DOUBLE_WAVY
Constant for a double wavy border

BORDER_EMBOSS

public static final int BORDER_EMBOSS
Constant for an embossed border

BORDER_ENGRAVE

public static final int BORDER_ENGRAVE
Constant for an engraved border

BORDER_HAIRLINE

public static final int BORDER_HAIRLINE
Constant for a hairline border

BORDER_NONE

public static final int BORDER_NONE
Constant for a border with no border

BORDER_SHADOWED

public static final int BORDER_SHADOWED
Constant for a shadowed border

BORDER_SINGLE

public static final int BORDER_SINGLE
Constant for a single border

BORDER_STRIPED

public static final int BORDER_STRIPED
Constant for a striped border

BORDER_STYLE_DASHED

protected static final byte[] BORDER_STYLE_DASHED
Constant for the dashed border style

BORDER_STYLE_DOTTED

protected static final byte[] BORDER_STYLE_DOTTED
Constant for the dotted border style

BORDER_STYLE_DOT_DASH

protected static final byte[] BORDER_STYLE_DOT_DASH
Constant for the dot dash border style

BORDER_STYLE_DOT_DOT_DASH

protected static final byte[] BORDER_STYLE_DOT_DOT_DASH
Constant for the dot dot dash border style

BORDER_STYLE_DOUBLE

protected static final byte[] BORDER_STYLE_DOUBLE
Constant for the double border style

BORDER_STYLE_DOUBLE_THICK

protected static final byte[] BORDER_STYLE_DOUBLE_THICK
Constant for the double thick border style

BORDER_STYLE_DOUBLE_WAVY

protected static final byte[] BORDER_STYLE_DOUBLE_WAVY
Constant for the double wavy border style

BORDER_STYLE_EMBOSS

protected static final byte[] BORDER_STYLE_EMBOSS
Constant for the embossed border style

BORDER_STYLE_ENGRAVE

protected static final byte[] BORDER_STYLE_ENGRAVE
Constant for the engraved border style

BORDER_STYLE_HAIRLINE

protected static final byte[] BORDER_STYLE_HAIRLINE
Constant for the hairline border style

BORDER_STYLE_SHADOWED

protected static final byte[] BORDER_STYLE_SHADOWED
Constant for the shadowed border style

BORDER_STYLE_SINGLE

protected static final byte[] BORDER_STYLE_SINGLE
Constant for the single border style

BORDER_STYLE_STRIPED

protected static final byte[] BORDER_STYLE_STRIPED
Constant for the striped border style

BORDER_STYLE_THICK_THIN

protected static final byte[] BORDER_STYLE_THICK_THIN
Constant for the thick thin border style

BORDER_STYLE_THICK_THIN_LARGE

protected static final byte[] BORDER_STYLE_THICK_THIN_LARGE
Constant for the thick thin large border style

BORDER_STYLE_THICK_THIN_MED

protected static final byte[] BORDER_STYLE_THICK_THIN_MED
Constant for the thick thin medium border style

BORDER_STYLE_THIN_THICK

protected static final byte[] BORDER_STYLE_THIN_THICK
Constant for the thin thick border style

BORDER_STYLE_THIN_THICK_LARGE

protected static final byte[] BORDER_STYLE_THIN_THICK_LARGE
Constant for the thin thick large border style

BORDER_STYLE_THIN_THICK_MED

protected static final byte[] BORDER_STYLE_THIN_THICK_MED
Constant for the thin thick medium border style

BORDER_STYLE_THIN_THICK_THIN

protected static final byte[] BORDER_STYLE_THIN_THICK_THIN
Constant for the thin thick thin border style

BORDER_STYLE_THIN_THICK_THIN_LARGE

protected static final byte[] BORDER_STYLE_THIN_THICK_THIN_LARGE
Constant for the thin thick thin large border style

BORDER_STYLE_THIN_THICK_THIN_MED

protected static final byte[] BORDER_STYLE_THIN_THICK_THIN_MED
Constant for the thin thick thin medium border style

BORDER_STYLE_TRIPLE

protected static final byte[] BORDER_STYLE_TRIPLE
Constant for the triple border style

BORDER_STYLE_WAVY

protected static final byte[] BORDER_STYLE_WAVY
Constant for the wavy border style

BORDER_THICK_THIN

public static final int BORDER_THICK_THIN
Constant for a thick thin border

BORDER_THICK_THIN_LARGE

public static final int BORDER_THICK_THIN_LARGE
Constant for a thick thin large border

BORDER_THICK_THIN_MED

public static final int BORDER_THICK_THIN_MED
Constant for a thick thin medium border

BORDER_THIN_THICK

public static final int BORDER_THIN_THICK
Constant for a thin thick border

BORDER_THIN_THICK_LARGE

public static final int BORDER_THIN_THICK_LARGE
Constant for a thin thick large border

BORDER_THIN_THICK_MED

public static final int BORDER_THIN_THICK_MED
Constant for a thin thick medium border

BORDER_THIN_THICK_THIN

public static final int BORDER_THIN_THICK_THIN
Constant for a thin thick thin border

BORDER_THIN_THICK_THIN_LARGE

public static final int BORDER_THIN_THICK_THIN_LARGE
Constant for a thin thick thin large border

BORDER_THIN_THICK_THIN_MED

public static final int BORDER_THIN_THICK_THIN_MED
Constant for a thin thick thin medium border

BORDER_TRIPLE

public static final int BORDER_TRIPLE
Constant for a triple border

BORDER_WAVY

public static final int BORDER_WAVY
Constant for a wavy border

BORDER_WIDTH

protected static final byte[] BORDER_WIDTH
Constant for the border width

BOTTOM_BORDER

protected static final int BOTTOM_BORDER
Constant for a bottom border

BOX_BORDER

protected static final int BOX_BORDER
Constant for a box (left, top, right, bottom) border

CELL_BORDER

protected static final int CELL_BORDER
Constant for a cell border

CELL_BORDER_BOTTOM

protected static final byte[] CELL_BORDER_BOTTOM
Constant for the bottom cell border

CELL_BORDER_LEFT

protected static final byte[] CELL_BORDER_LEFT
Constant for the left cell border

CELL_BORDER_RIGHT

protected static final byte[] CELL_BORDER_RIGHT
Constant for the right cell border

CELL_BORDER_TOP

protected static final byte[] CELL_BORDER_TOP
Constant for the top cell border

HORIZONTAL_BORDER

protected static final int HORIZONTAL_BORDER
Constant for a horizontal line

LEFT_BORDER

protected static final int LEFT_BORDER
Constant for a left border

NO_BORDER

protected static final int NO_BORDER
This border is no border :-)

RIGHT_BORDER

protected static final int RIGHT_BORDER
Constant for a right border

ROW_BORDER

protected static final int ROW_BORDER
Constant for a row border

ROW_BORDER_BOTTOM

protected static final byte[] ROW_BORDER_BOTTOM
Constant for the bottom row border

ROW_BORDER_HORIZONTAL

protected static final byte[] ROW_BORDER_HORIZONTAL
Constant for the horizontal line

ROW_BORDER_LEFT

protected static final byte[] ROW_BORDER_LEFT
Constant for the left row border

ROW_BORDER_RIGHT

protected static final byte[] ROW_BORDER_RIGHT
Constant for the right row border

ROW_BORDER_TOP

protected static final byte[] ROW_BORDER_TOP
Constant for the top row border

ROW_BORDER_VERTICAL

protected static final byte[] ROW_BORDER_VERTICAL
Constant for the vertical line

TOP_BORDER

protected static final int TOP_BORDER
Constant for a top border

VERTICAL_BORDER

protected static final int VERTICAL_BORDER
Constant for a vertical line

Constructor Detail

RtfBorder

protected RtfBorder(RtfDocument doc, int borderType, RtfBorder border)
Makes a copy of the given RtfBorder

Parameters: doc The RtfDocument this RtfBorder belongs to borderType The border type of this RtfBorder border The RtfBorder to copy

RtfBorder

protected RtfBorder(RtfDocument doc, int borderType, int borderPosition, int borderStyle, float borderWidth, Color borderColor)
Constructs a RtfBorder

Parameters: doc The RtfDocument this RtfBorder belongs to borderType The type of border this RtfBorder is borderPosition The position of this RtfBorder borderStyle The style of this RtfBorder borderWidth The width of this RtfBorder borderColor The colour of this RtfBorder

Method Detail

getBorderColor

protected RtfColor getBorderColor()
Gets the colour of this RtfBorder

Returns: Returns RtfColor of this RtfBorder

getBorderPosition

protected int getBorderPosition()
Gets the position of this RtfBorder

Returns: Returns the position of this RtfBorder

getBorderStyle

protected int getBorderStyle()
Gets the style of this RtfBorder

Returns: Returns the style of this RtfBorder

getBorderType

protected int getBorderType()
Gets the type of this RtfBorder

Returns: Returns the type of this RtfBorder

getBorderWidth

protected int getBorderWidth()
Gets the width of this RtfBorder

Returns: Returns the width of this RtfBorder

write

public byte[] write()
Writes the RtfBorder settings

Returns: A byte array with the RtfBorder settings

writeBorderStyle

private byte[] writeBorderStyle()
Writes the style of this RtfBorder

Returns: A byte array containing the style of this RtfBorder