Module itextpdf

Package com.itextpdf.text.pdf

Class PdfCell

java.lang.Object

com.itextpdf.text.Rectangle

com.itextpdf.text.pdf.PdfCell

All Implemented Interfaces:

Element

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.itextpdf.text.Rectangle

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

Fields inherited from interface com.itextpdf.text.Element

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
float	cellpadding()	Gets the cellpadding of a cell..
float	cellspacing()	Gets the cellspacing of a cell.
float	getBottom()	Returns the lower left y-coordinate.
int	getGroupNumber()	Gets the number of the group this cell is in..
java.util.ArrayList	getImages(float top, float bottom)	Gets the images of a cell that can be drawn between certain limits.
float	getLeft()	Returns the lower left x-coordinate.
java.util.ArrayList	getLines(float top, float bottom)	Gets the lines of a cell that can be drawn between certain limits.
float	getRight()	Returns the upper right x-coordinate.
float	getTop()	Returns the upper right y-coordinate.
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.
protected void	processActions(Element element, PdfAction action, java.util.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	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.

Methods inherited from class com.itextpdf.text.Rectangle

cloneNonPositionParameters, disableBorderSide, enableBorderSide, getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getChunks, getGrayFill, getHeight, getLeft, getRight, getRotation, getTop, getWidth, hasBorder, hasBorders, isContent, isNestable, isUseVariableBorders, normalize, process, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderColorBottom, setBorderColorLeft, setBorderColorRight, setBorderColorTop, setBorderWidth, setBorderWidthBottom, setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, setGrayFill, setLeft, setRight, setTop, setUseVariableBorders, softCloneNonPositionParameters, toString, type

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 -

getLeft

public float getLeft()

Returns the lower left x-coordinate.

Overrides:

getLeft in class Rectangle

Returns:

the lower left x-coordinate

getRight

public float getRight()

Returns the upper right x-coordinate.

Overrides:

getRight in class Rectangle

Returns:

the upper right x-coordinate

getTop

public float getTop()

Returns the upper right y-coordinate.

Overrides:

getTop in class Rectangle

Returns:

the upper right y-coordinate

getBottom

public float getBottom()

Returns the lower left y-coordinate.

Overrides:

getBottom in class Rectangle

Returns:

the lower left y-coordinate

getLines

public java.util.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 java.util.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

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,
                              java.util.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 layout for borders if true

isUseBorderPadding

public boolean isUseBorderPadding()

Gets the value of useBorderPadding.

Returns:

useBorderPadding