com.lowagie.text

Class Cell

public class Cell extends Rectangle implements TextElementArray

A Cell is a Rectangle containing other Elements.

A Cell must be added to a Table. The Table will place the Cell in a Row.

Example:

 Table table = new Table(3);
 table.setBorderWidth(1);
 table.setBorderColor(new Color(0, 0, 255));
 table.setCellpadding(5);
 table.setCellspacing(5);
 Cell cell = new Cell("header");
 cell.setHeader(true);
 cell.setColspan(3);
 table.addCell(cell);
 cell = new Cell("example cell with colspan 1 and rowspan 2");
 cell.setRowspan(2);
 cell.setBorderColor(new Color(255, 0, 0));
 table.addCell(cell);
 table.addCell("1.1");
 table.addCell("2.1");
 table.addCell("1.2");
 table.addCell("2.2");

See Also: Rectangle Element Table Row

Field Summary
protected ArrayList	arrayList The `ArrayList` of `Element`s that are part of the content of the Cell.
protected int	colspan The colspan of the cell.
protected boolean	groupChange Does this `Cell` force a group change?
protected boolean	header Is this `Cell` a header?
protected int	horizontalAlignment The horizontal alignment of the cell content.
float	leading The leading of the content inside the cell.
protected int	maxLines Maximum number of lines allowed in the cell.
protected boolean	percentage
protected int	rowspan The rowspan of the cell.
String	showTruncation If a truncation happens due to the maxLines property, then this text will be added to indicate a truncation has happened.
protected boolean	useAscender Indicates that the largest ascender height should be used to determine the height of the first line.
protected boolean	useBorderPadding Adjusts the cell contents to compensate for border widths.
protected boolean	useDescender Indicates that the largest descender height should be added to the height of the last line (so characters like y don't dip into the border).
protected int	verticalAlignment The vertical alignment of the cell content.
protected float	width The width of the cell as a String.

Constructor Summary
	Cell() Constructs an empty `Cell`.
	Cell(boolean dummy) Constructs an empty `Cell` (for internal use only).
	Cell(String content) Constructs a `Cell` with a certain content. The `String` will be converted into a `Paragraph`.
	Cell(Element element) Constructs a `Cell` with a certain `Element`. if the element is a `ListItem`, `Row` or `Cell`, an exception will be thrown.

Method Summary
boolean	add(Object o) Add an `Object` to this cell.
void	addElement(Element element) Adds an element to this `Cell`.
float	bottom(int margin) This method throws an `UnsupportedOperationException`.
void	clear() Clears all the `Element`s of this `Cell`.
PdfPCell	createPdfPCell() Creates a PdfPCell based on this Cell object.
void	fill() Makes sure there is at least 1 object in the Cell.
float	getBottom() This method throws an `UnsupportedOperationException`.
ArrayList	getChunks() Gets all the chunks in this element.
int	getColspan() Gets the colspan.
static Cell	getDummyCell() Get dummy cell used when merging inner tables.
Iterator	getElements() Gets an iterator of `Element`s.
boolean	getGroupChange() Does this `Cell` force a group change?
int	getHorizontalAlignment() Gets the horizontal alignment.
float	getLeading() Gets the leading.
float	getLeft() This method throws an `UnsupportedOperationException`.
int	getMaxLines() Getter for maxLines
float	getRight() This method throws an `UnsupportedOperationException`.
int	getRowspan() Gets the rowspan.
String	getShowTruncation() Getter for showTruncation
float	getTop() This method throws an `UnsupportedOperationException`.
int	getVerticalAlignment() Gets the vertical alignment.
float	getWidth() Gets the width.
String	getWidthAsString() Gets the width as a String.
boolean	isEmpty() Checks if the `Cell` is empty.
boolean	isHeader() Is this `Cell` a header?
boolean	isTable() Checks if this `Cell` is a placeholder for a (nested) table.
boolean	isUseAscender() Gets the value of useAscender
boolean	isUseBorderPadding() Gets the value of useBorderPadding.
boolean	isUseDescender() gets the value of useDescender
float	left(int margin) This method throws an `UnsupportedOperationException`.
boolean	process(ElementListener listener) Processes the element by adding it (or the different parts) to an `ElementListener`.
float	right(int margin) This method throws an `UnsupportedOperationException`.
void	setBottom(int value) This method throws an `UnsupportedOperationException`.
void	setColspan(int value) Sets the colspan.
void	setGroupChange(boolean value) Sets group change.
void	setHeader(boolean value) Sets header.
void	setHorizontalAlignment(int value) Sets the horizontal alignment.
void	setHorizontalAlignment(String alignment) Sets the alignment of this cell.
void	setLeading(float value) Sets the leading.
void	setLeft(int value) This method throws an `UnsupportedOperationException`.
void	setMaxLines(int value) Setter for maxLines
void	setRight(int value) This method throws an `UnsupportedOperationException`.
void	setRowspan(int value) Sets the rowspan.
void	setShowTruncation(String value) Setter for showTruncation
void	setTop(int value) This method throws an `UnsupportedOperationException`.
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.
void	setVerticalAlignment(int value) Sets the vertical alignment.
void	setVerticalAlignment(String alignment) Sets the alignment of this paragraph.
void	setWidth(float value) Sets the width.
void	setWidth(String value) Sets the width.
int	size() Gets the number of `Element`s in the Cell.
float	top(int margin) This method throws an `UnsupportedOperationException`.
int	type() Gets the type of the text element.

Field Detail

arrayList

protected ArrayList arrayList

The ArrayList of Elements that are part of the content of the Cell.

colspan

protected int colspan

The colspan of the cell.

groupChange

protected boolean groupChange

Does this Cell force a group change?

header

protected boolean header

Is this Cell a header?

horizontalAlignment

protected int horizontalAlignment

The horizontal alignment of the cell content.

leading

float leading

The leading of the content inside the cell.

maxLines

protected int maxLines

Maximum number of lines allowed in the cell. The default value of this property is not to limit the maximum number of lines (contributed by dperezcar@fcc.es)

rowspan

protected int rowspan

The rowspan of the cell.

If a truncation happens due to the maxLines property, then this text will be added to indicate a truncation has happened. Default value is null, and means avoiding marking the truncation. A useful value of this property could be e.g. "..." (contributed by dperezcar@fcc.es)

useAscender

protected boolean useAscender

Indicates that the largest ascender height should be used to determine the height of the first line. Note that this only has an effect when rendered to PDF. Setting this to true can help with vertical alignment problems.

useBorderPadding

protected boolean useBorderPadding

Adjusts the cell contents to compensate for border widths. Note that this only has an effect when rendered to PDF.

useDescender

protected boolean useDescender

Indicates that the largest descender height should be added to the height of the last line (so characters like y don't dip into the border). Note that this only has an effect when rendered to PDF.

verticalAlignment

protected int verticalAlignment

The vertical alignment of the cell content.

public Cell(String content)

Constructs a Cell with a certain content.

The String will be converted into a Paragraph.

Parameters: content a String

Cell

public Cell(Element element)

Constructs a Cell with a certain Element.

if the element is a ListItem, Row or Cell, an exception will be thrown.

Parameters: element the element

Throws: BadElementException when the creator was called with a ListItem, Row or Cell

Method Detail

add

public boolean add(Object o)

Add an Object to this cell.

Parameters: o the object to add

Returns: always true

addElement

public void addElement(Element element)

Adds an element to this Cell.

Remark: you can't add ListItems, Rows, Cells, JPEGs, GIFs or PNGs to a Cell.

Parameters: element The Element to add

Throws: BadElementException if the method was called with a ListItem, Row or Cell

bottom

public float bottom(int margin)

This method throws an UnsupportedOperationException.

Parameters: margin

Returns: NA

clear

public void clear()

Clears all the Elements of this Cell.

createPdfPCell

public PdfPCell createPdfPCell()

Creates a PdfPCell based on this Cell object.

Returns: a PdfPCell

Throws: BadElementException

public int getVerticalAlignment()

Gets the vertical alignment.

Returns: a value

getWidth

public float getWidth()

Gets the width.

getWidthAsString

public String getWidthAsString()

Gets the width as a String.

Returns: a value

isEmpty

public boolean isEmpty()

Checks if the Cell is empty.

Returns: false if there are non-empty Elements in the Cell.

isHeader

public boolean isHeader()

Is this Cell a header?

Returns: a value

isTable

public boolean isTable()

Checks if this Cell is a placeholder for a (nested) table.

Returns: true if the only element in this cell is a table

isUseAscender

public boolean isUseAscender()

Gets the value of useAscender

Returns: useAscender

isUseBorderPadding

public boolean isUseBorderPadding()

Gets the value of useBorderPadding.

Returns: useBorderPadding

isUseDescender

public boolean isUseDescender()

gets the value of useDescender

Returns: useDescender

left

public float left(int margin)

This method throws an UnsupportedOperationException.

Parameters: margin

Returns: NA

process

public boolean process(ElementListener listener)

Processes the element by adding it (or the different parts) to an ElementListener.

Parameters: listener an ElementListener

Returns: true if the element was processed successfully

right

public float right(int margin)

This method throws an UnsupportedOperationException.

Parameters: margin NA

Returns: NA

setBottom

public void setBottom(int value)

This method throws an UnsupportedOperationException.

Parameters: value NA

setColspan

public void setColspan(int value)

Sets the colspan.

Parameters: value the new value

setGroupChange

public void setGroupChange(boolean value)

Sets group change.

Parameters: value the new value

setHeader

public void setHeader(boolean value)

Sets header.

Parameters: value the new value

setHorizontalAlignment

public void setHorizontalAlignment(int value)

Sets the horizontal alignment.

Parameters: value the new value

setHorizontalAlignment

public void setHorizontalAlignment(String alignment)

Sets the alignment of this cell. This methods allows you to set the alignment as a String.

Parameters: alignment the new alignment as a String

setLeading

public void setLeading(float value)

Sets the leading.

Parameters: value the new value

setLeft

public void setLeft(int value)

This method throws an UnsupportedOperationException.

Parameters: value NA

setMaxLines

public void setMaxLines(int value)

Setter for maxLines

Parameters: value the maximum number of lines

setRight

public void setRight(int value)

This method throws an UnsupportedOperationException.

Parameters: value NA

setRowspan

public void setRowspan(int value)

Sets the rowspan.

Parameters: value the new value

setShowTruncation

public void setShowTruncation(String value)

Setter for showTruncation

Parameters: value Can be null for avoiding marking the truncation.

setTop

public void setTop(int value)

This method throws an UnsupportedOperationException.

Parameters: value NA

setUseAscender

public void setUseAscender(boolean use)

Sets the value of useAscender.

Parameters: use use ascender height if true

setUseBorderPadding

public void setUseBorderPadding(boolean use)

Sets the value of useBorderPadding.

Parameters: use adjust layout for borders if true

setUseDescender

public void setUseDescender(boolean use)

Sets the value of useDescender.

Parameters: use use descender height if true

setVerticalAlignment

public void setVerticalAlignment(int value)

Sets the vertical alignment.

Parameters: value the new value

setVerticalAlignment

public void setVerticalAlignment(String alignment)

Sets the alignment of this paragraph.

Parameters: alignment the new alignment as a String

setWidth

public void setWidth(float value)

Sets the width.

Parameters: value the new value

setWidth

public void setWidth(String value)

Sets the width. It can be an absolute value "100" or a percentage "20%"

Parameters: value the new value

size

public int size()

Gets the number of Elements in the Cell.

Returns: a size.

top

public float top(int margin)

This method throws an UnsupportedOperationException.

Parameters: margin

Returns: NA

type

public int type()

Gets the type of the text element.

Returns: a type