com.lowagie.text.pdf
Class PdfCell

java.lang.Object
  com.lowagie.text.Rectangle
      com.lowagie.text.pdf.PdfCell

All Implemented Interfaces:

Element, MarkupAttributes

public class PdfCell
extends Rectangle

A PdfCell is the PDF translation of a Cell.

A PdfCell is an ArrayList of PdfLines.

When using variable borders (isUseVariableBorders() == true), the borders are drawn completely inside the cell Rectangle so that adjacent cell borders will not overlap. Otherwise, the borders are drawn on top of the edges of the cell Rectangle and will overlap the borders of adjacent cells.

See Also:

Rectangle, Cell, PdfLine, PdfTable

Field Summary

Fields inherited from class com.lowagie.text.Rectangle

background, border, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, color, LEFT, llx, lly, markupAttributes, NO_BORDER, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders

Constructor Summary

PdfCell(Cell cell, int rownumber, float left, float right, float top, float cellspacing, float cellpadding)
Constructs a PdfCell-object.

Method Summary

float	bottom() Returns the lower left y-coordinate.
float	cellpadding() Gets the cellpadding of a cell..
float	cellspacing() Gets the cellspacing of a cell.
int	getGroupNumber() Gets the number of the group this cell is in..
ArrayList	getImages(float top, float bottom) Gets the images of a cell that can be drawn between certain limits.
ArrayList	getLines(float top, float bottom) Gets the lines of a cell that can be drawn between certain limits.
boolean	isUseAscender() Gets the value of useAscender
boolean	isUseBorderPadding() Gets the value of useBorderPadding.
boolean	isUseDescender() gets the value of useDescender
float	leading() Gets the leading of a cell.
float	left() Returns the lower left x-coordinaat.
protected void	processActions(Element element, PdfAction action, ArrayList allActions) Processes all actions contained in the cell.
Rectangle	rectangle(float top, float bottom) Gets a Rectangle that is altered to fit on the page.
float	remainingHeight() Returns the height needed to draw the remaining text.
int	remainingLines() Returns the number of lines in the cell that are not empty.
float	right() Returns the upper right x-coordinate.
int	rownumber() Gets the number of the row this cell is in..
int	rowspan() Gets the rowspan of a cell.
void	setBottom(float value) Sets the bottom of the Rectangle and determines the proper {link #verticalOffset} to appropriately align the contents vertically.
void	setUseAscender(boolean use) Sets the value of useAscender.
void	setUseBorderPadding(boolean use) Sets the value of useBorderPadding.
void	setUseDescender(boolean use) Sets the value of useDescender.
int	size() Returns the number of lines in the cell.
float	top() Returns the upper right y-coordinate.

Methods inherited from class com.lowagie.text.Rectangle

backgroundColor, border, borderColor, borderWidth, bottom, cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getChunks, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getRotation, grayFill, hasBorder, hasBorders, height, isUseVariableBorders, left, normalize, process, right, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setGrayFill, setLeft, setMarkupAttribute, setMarkupAttributes, setRight, setTop, setUseVariableBorders, softCloneNonPositionParameters, top, toString, type, width

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfCell

public PdfCell(Cell cell,
               int rownumber,
               float left,
               float right,
               float top,
               float cellspacing,
               float cellpadding)

Constructs a PdfCell-object.

Parameters:

cell - the original Cell

rownumber - the number of the Row the Cell was in.

left - the left border of the PdfCell

right - the right border of the PdfCell

top - the top border of the PdfCell

cellspacing - the cellspacing of the Table

cellpadding - the cellpadding of the Table

Method Detail

setBottom

public void setBottom(float value)

Sets the bottom of the Rectangle and determines the proper {link #verticalOffset} to appropriately align the contents vertically.

Overrides:

setBottom in class Rectangle

Parameters:

value -

left

public float left()

Returns the lower left x-coordinaat.

Overrides:

left in class Rectangle

Returns:

the lower left x-coordinaat

right

public float right()

Returns the upper right x-coordinate.

Overrides:

right in class Rectangle

Returns:

the upper right x-coordinate

top

public float top()

Returns the upper right y-coordinate.

Overrides:

top in class Rectangle

Returns:

the upper right y-coordinate

bottom

public float bottom()

Returns the lower left y-coordinate.

Overrides:

bottom in class Rectangle

Returns:

the lower left y-coordinate

getLines

public ArrayList getLines(float top,
                          float bottom)

Gets the lines of a cell that can be drawn between certain limits.

Remark: all the lines that can be drawn are removed from the object!

Parameters:

top - the top of the part of the table that can be drawn

bottom - the bottom of the part of the table that can be drawn

Returns:

an ArrayList of PdfLines

getImages

public ArrayList getImages(float top,
                           float bottom)

Gets the images of a cell that can be drawn between certain limits.

Remark: all the lines that can be drawn are removed from the object!

Parameters:

top - the top of the part of the table that can be drawn

bottom - the bottom of the part of the table that can be drawn

Returns:

an ArrayList of Images

size

public int size()

Returns the number of lines in the cell.

Returns:

a value

remainingLines

public int remainingLines()

Returns the number of lines in the cell that are not empty.

Returns:

a value

remainingHeight

public float remainingHeight()

Returns the height needed to draw the remaining text.

Returns:

a height

leading

public float leading()

Gets the leading of a cell.

Returns:

the leading of the lines is the cell.

rownumber

public int rownumber()

Gets the number of the row this cell is in..

Returns:

a number

rowspan

public int rowspan()

Gets the rowspan of a cell.

Returns:

the rowspan of the cell

cellspacing

public float cellspacing()

Gets the cellspacing of a cell.

Returns:

a value

cellpadding

public float cellpadding()

Gets the cellpadding of a cell..

Returns:

a value

processActions

protected void processActions(Element element,
                              PdfAction action,
                              ArrayList allActions)

Processes all actions contained in the cell.

Parameters:

element - an element in the cell

action - an action that should be coupled to the cell

allActions -

getGroupNumber

public int getGroupNumber()

Gets the number of the group this cell is in..

Returns:

a number

rectangle

public Rectangle rectangle(float top,
                           float bottom)

Gets a Rectangle that is altered to fit on the page.

Overrides:

rectangle in class Rectangle

Parameters:

top - the top position

bottom - the bottom position

Returns:

a Rectangle

setUseAscender

public void setUseAscender(boolean use)

Sets the value of useAscender.

Parameters:

use - use ascender height if true

isUseAscender

public boolean isUseAscender()

Gets the value of useAscender

Returns:

useAscender

setUseDescender

public void setUseDescender(boolean use)

Sets the value of useDescender.

Parameters:

use - use descender height if true

isUseDescender

public boolean isUseDescender()

gets the value of useDescender

Returns:

useDescender

setUseBorderPadding

public void setUseBorderPadding(boolean use)

Sets the value of useBorderPadding.

Parameters:

use - adjust layour for borders if true

isUseBorderPadding

public boolean isUseBorderPadding()

Gets the value of useBorderPadding.

Returns:

useBorderPadding