com.cete.dynamicpdf.pageelements
Class Cell

java.lang.Object
  |
  +--com.cete.dynamicpdf.pageelements.Cell

public class Cell

extends java.lang.Object

Class represents a cell of a table.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Method Summary

CellAlign	getAlign() Gets the CellAlign enumeration to use for the horizontal alignment of the text in the cell.
boolean	getAutoLeading() Gets whether the leading of the cell should be calculated automatically.
Color	getBackgroundColor() Gets the Color object to use for the background of the cell.
int	getColumnIndex() Gets the index of the Column in which the cell begins.
int	getColumnSpan() Gets the number of columns that the cell spans.
PageElement	getElement() Gets the page element contained in the cell.
Font	getFont() Gets the Font object to use for the cell.
float	getFontSize() Gets the font size to use for the text in the cell.
float	getHeight() Gets the height of the cell.
float	getLeading() Gets the leading for the text of the cell.
float	getPadding() Gets the padding of the cell.
float	getParagraphIndent() Gets the paragraph indent for the paragraphs of the cell.
float	getParagraphSpacing() Gets the paragraph spacing for the paragraphs of the cell.
boolean	getRightToLeft() Gets a value specifying whether the text in the cell will be displayed right to left.
Row	getRow() Gets the Row that the cell is contained in.
int	getRowSpan() Gets the number of rows that the cell spans.
java.lang.String	getText() Gets the text to be displayed.
Color	getTextColor() Gets the Color object to use for the text of the cell.
boolean	getUnderline() Gets a value specifying whether the text in the cell will be underlined.
CellVAlign	getVAlign() Gets the CellVAlign enumeration to use for the vertical alignment of the text in the cell.
float	getWidth() Gets the width of the cell.
void	setAlign(CellAlign value) Sets the CellAlign enumeration to use for the horizontal alignment of the text in the cell.
void	setAutoLeading(boolean value) Sets whether the leading of the cell should be calculated automatically.
void	setBackgroundColor(Color value) Sets the Color object to use for the background of the cell.
void	setColumnSpan(int value) Sets the number of columns that the cell spans.
void	setElement(PageElement value) Sets the page element contained in the cell.
void	setFont(Font value) Sets the Font object to use for the cell.
void	setFontSize(float value) Sets the font size to use for the text in the cell.
void	setLeading(float value) Sets the leading for the text of the cell.
void	setPadding(float value) Sets the padding of the cell.
void	setParagraphIndent(float value) Set the paragraph indent for the paragraphs of the cell.
void	setParagraphSpacing(float value) Gets the paragraph spacing for the paragraphs of the cell.
void	setRightToLeft(boolean value) Sets a value specifying whether the text in the cell will be displayed right to left.
void	setRowSpan(int value) Sets the number of rows that the cell spans.
void	setText(java.lang.String value) Sets the text to be displayed.
void	setTextColor(Color value) Sets the Color object to use for the text of the cell.
void	setUnderline(boolean value) Sets a value specifying whether the text in the cell will be underlined.
void	setVAlign(CellVAlign value) Sets the CellVAlign enumeration to use for the vertical alignment of the text in the cell.

Methods inherited from class java.lang.Object

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

Method Detail

getText

public java.lang.String getText()

Gets the text to be displayed.

Throws:

TableException - If there is no text in the cell.

setText

public void setText(java.lang.String value)

Sets the text to be displayed.

getElement

public PageElement getElement()

Gets the page element contained in the cell.

setElement

public void setElement(PageElement value)

Sets the page element contained in the cell.

getPadding

public float getPadding()

Gets the padding of the cell. By default this value is set to float.NaN. Being set to 'Not a Number' implies that the cell's padding will be pulled from the padding for the row containing that cell.

setPadding

public void setPadding(float value)

Sets the padding of the cell.

getRow

public Row getRow()

Gets the Row that the cell is contained in.

See Also:

Row

getColumnIndex

public int getColumnIndex()

Gets the index of the Column in which the cell begins.

See Also:

Column

getWidth

public float getWidth()

Gets the width of the cell.

getFont

public Font getFont()

Gets the Font object to use for the cell.

See Also:

Font

setFont

public void setFont(Font value)

Sets the Font object to use for the cell.

See Also:

Font

getFontSize

public float getFontSize()

Gets the font size to use for the text in the cell.

setFontSize

public void setFontSize(float value)

Sets the font size to use for the text in the cell.

getColumnSpan

public int getColumnSpan()

Gets the number of columns that the cell spans.

setColumnSpan

public void setColumnSpan(int value)

Sets the number of columns that the cell spans.

getRowSpan

public int getRowSpan()

Gets the number of rows that the cell spans.

setRowSpan

public void setRowSpan(int value)

Sets the number of rows that the cell spans.

getTextColor

public Color getTextColor()

Gets the Color object to use for the text of the cell.

See Also:

Color

setTextColor

public void setTextColor(Color value)

Sets the Color object to use for the text of the cell.

See Also:

Color

getAlign

public CellAlign getAlign()

Gets the CellAlign enumeration to use for the horizontal alignment of the text in the cell.

See Also:

CellAlign

setAlign

public void setAlign(CellAlign value)

Sets the CellAlign enumeration to use for the horizontal alignment of the text in the cell.

See Also:

CellAlign

getVAlign

public CellVAlign getVAlign()

Gets the CellVAlign enumeration to use for the vertical alignment of the text in the cell.

See Also:

CellVAlign

setVAlign

public void setVAlign(CellVAlign value)

Sets the CellVAlign enumeration to use for the vertical alignment of the text in the cell.

See Also:

CellVAlign

getBackgroundColor

public Color getBackgroundColor()

Gets the Color object to use for the background of the cell.

See Also:

Color

setBackgroundColor

public void setBackgroundColor(Color value)

Sets the Color object to use for the background of the cell.

See Also:

Color

getLeading

public float getLeading()

Gets the leading for the text of the cell.

Throws:

TableException - If there is no text in the cell and no associated value for leading.

setLeading

public void setLeading(float value)

Sets the leading for the text of the cell.

Setting this method will automatically set the Cell.setAutoLeading(boolean value) method to false.

getAutoLeading

public boolean getAutoLeading()

Gets whether the leading of the cell should be calculated automatically.

Returns:

The leading of the cell calculated automatically, true by default.

setAutoLeading

public void setAutoLeading(boolean value)

Sets whether the leading of the cell should be calculated automatically.

This method is automatically set to false any time the Cell.setLeading(float value) method is set.

getParagraphSpacing

public float getParagraphSpacing()

Gets the paragraph spacing for the paragraphs of the cell.

Throws:

TableException - If there is no text in the cell and no associated value for paragraph spacing.

setParagraphSpacing

public void setParagraphSpacing(float value)

Gets the paragraph spacing for the paragraphs of the cell.

getParagraphIndent

public float getParagraphIndent()

Gets the paragraph indent for the paragraphs of the cell.

Throws:

TableException - If there is no text in the cell and no associated value for paragraph indent.

setParagraphIndent

public void setParagraphIndent(float value)

Set the paragraph indent for the paragraphs of the cell.

getUnderline

public boolean getUnderline()

Gets a value specifying whether the text in the cell will be underlined.

setUnderline

public void setUnderline(boolean value)

Sets a value specifying whether the text in the cell will be underlined.

getRightToLeft

public boolean getRightToLeft()

Gets a value specifying whether the text in the cell will be displayed right to left.

setRightToLeft

public void setRightToLeft(boolean value)

Sets a value specifying whether the text in the cell will be displayed right to left.

getHeight

public float getHeight()

Gets the height of the cell.