com.lowagie.text.pdf
Class PdfCell

java.lang.Object
  extended bycom.lowagie.text.Rectangle
      extended bycom.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.

See Also:
Rectangle, Cell, PdfLine, PdfTable

Field Summary
private  float cellpadding
          This is the cellpadding of the cell.
private  float cellspacing
          This is the cellspacing of the cell.
private  int groupNumber
          This is the number of the group the cell is in.
private  boolean header
          Indicates if this cell belongs to the header of a PdfTable
private  ArrayList images
          These are the Images in the Cell.
private  float leading
          This is the leading of the lines.
private  PdfLine line
          These are the PdfLines in the Cell.
private  ArrayList lines
          These are the PdfLines in the Cell.
private  int rownumber
          This is the number of the row the cell is in.
private  int rowspan
          This is the rowspan of the cell.
 
Fields inherited from class com.lowagie.text.Rectangle
background, border, borderWidth, BOTTOM, BOX, color, grayFill, LEFT, llx, lly, markupAttributes, NO_BORDER, RIGHT, rotation, TOP, UNDEFINED, urx, ury
 
Fields inherited from interface com.lowagie.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, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE
 
Constructor Summary
PdfCell(Cell cell, int rownumber, float left, float right, float top, float cellspacing, float cellpadding)
          Constructs a PdfCell-object.
 
Method Summary
private  float addImage(Image i, float left, float right, float height, int alignment)
          Adds an image to this Cell.
 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.
(package private)  boolean isHeader()
          Checks if this cell belongs to the header of a PdfTable.
 float leading()
          Gets the leading of a cell.
 float left()
          Returns the lower left x-coordinaat.
(package private)  boolean mayBeRemoved()
          Checks if the cell may be removed.
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.
(package private)  void setGroupNumber(int number)
          Sets the group number.
(package private)  void setHeader()
          Indicates that this cell belongs to the header of a PdfTable.
 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, getChunks, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getRotation, grayFill, hasBorder, hasBorders, height, left, process, right, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderWidth, setBottom, setGrayFill, setLeft, setMarkupAttribute, setMarkupAttributes, setRight, setTop, top, type, width
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.lowagie.text.Element
toString
 

Field Detail

lines

private ArrayList lines
These are the PdfLines in the Cell.


line

private PdfLine line
These are the PdfLines in the Cell.


images

private ArrayList images
These are the Images in the Cell.


leading

private float leading
This is the leading of the lines.


rownumber

private int rownumber
This is the number of the row the cell is in.


rowspan

private int rowspan
This is the rowspan of the cell.


cellspacing

private float cellspacing
This is the cellspacing of the cell.


cellpadding

private float cellpadding
This is the cellpadding of the cell.


header

private boolean header
Indicates if this cell belongs to the header of a PdfTable


groupNumber

private int groupNumber
This is the number of the group the cell is in.

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

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

addImage

private float addImage(Image i,
                       float left,
                       float right,
                       float height,
                       int alignment)
Adds an image to this Cell.

Parameters:
i - the image to add
left - the left border
right - the right border

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

isHeader

boolean isHeader()
Checks if this cell belongs to the header of a PdfTable.

Returns:
void

setHeader

void setHeader()
Indicates that this cell belongs to the header of a PdfTable.


mayBeRemoved

boolean mayBeRemoved()
Checks if the cell may be removed.

Headers may allways be removed, even if they are drawn only partially: they will be repeated on each following page anyway!

Returns:
true if all the lines are allready drawn; false otherwise.

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.


getGroupNumber

public int getGroupNumber()
Gets the number of the group this cell is in..

Returns:
a number

setGroupNumber

void setGroupNumber(int number)
Sets the group 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