com.cete.dynamicpdf.pageelements
Class Cell2

java.lang.Object
  com.cete.dynamicpdf.pageelements.Cell2

public class Cell2
extends java.lang.Object

Represents a cell in the 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

TextAlign	getAlign() Gets the TextAlign enumeration to use for the horizontal alignment of the text in the cell.
java.lang.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.
Border	getBorder() Gets the Border object to use for the cell.
int	getColumnIndex() Gets the index of the Column2 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.
CellPadding	getPadding() Gets the Padding object to use for 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.
java.lang.Boolean	getRightToLeft() Gets a value specifying whether the text in the cell will be displayed right to left.
Row2	getRow() Gets the Row2 that the cell is contained in.
int	getRowSpan() Gets the number of rows that the cell spans.
boolean	getSplittable() Gets the value specifying whether the cell can be splittable.
Tag	getTag() Gets the structure element of the cell.
int	getTagOrder() Gets the structure element order of the cell.
java.lang.String	getText() Gets the text to be displayed.
Color	getTextColor() Gets the Color object to use for the text of the cell.
java.lang.Boolean	getUnderline() Gets a value specifying whether the text in the cell will be underlined.
VAlign	getVAlign() Gets the VAlign enumeration to use for the vertical alignment of the text in the cell.
float	getWidth() Gets the width of the cell.
void	setAlign(TextAlign value) Sets the TextAlign enumeration to use for the horizontal alignment of the text in the cell.
void	setAutoLeading(java.lang.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(CellPadding value) Sets the Padding object to use for the cell.
void	setParagraphIndent(float value) Sets the paragraph indent for the paragraphs of the cell.
void	setParagraphSpacing(float value) Sets the paragraph spacing for the paragraphs of the cell.
void	setRightToLeft(java.lang.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	setSplittable(boolean value) Sets the value specifying whether the cell can be splittable.
void	setTag(Tag value) Sets the structure element of the cell.
void	setTagOrder(int value) Sets the structure element order of the cell.
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(java.lang.Boolean value) Sets a value specifying whether the text in the cell will be underlined.
void	setVAlign(VAlign value) Sets the VAlign 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

getSplittable

public boolean getSplittable()

Gets the value specifying whether the cell can be splittable.

Returns:

the boolean value specifies whether the can be splittable.

setSplittable

public void setSplittable(boolean value)

Sets the value specifying whether the cell can be splittable.

Parameters:

value - the boolean value used to specify whether the cell can be splittable.

getText

public java.lang.String getText()

Gets the text to be displayed.

Returns:

The text to be displayed.

setText

public void setText(java.lang.String value)

Sets the text to be displayed.

Parameters:

value - The text to be displayed.

getElement

public PageElement getElement()

Gets the page element contained in the cell.

Returns:

The page element contained in the cell.

setElement

public void setElement(PageElement value)

Sets the page element contained in the cell.

Parameters:

value - The page element contained in the cell.

getPadding

public CellPadding getPadding()

Gets the Padding object to use for the cell.

Returns:

The Padding object to use for the cell.

setPadding

public void setPadding(CellPadding value)

Sets the Padding object to use for the cell.

Parameters:

value - The Padding object to use for the cell.

getBorder

public Border getBorder()

Gets the Border object to use for the cell.

Returns:

The Border object to use for the cell.

getFontSize

public float getFontSize()

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

Returns:

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.

Parameters:

value - The font size to use for the text in the cell.

getFont

public Font getFont()

Gets the Font object to use for the cell.

Returns:

The Font object to use for the cell.

setFont

public void setFont(Font value)

Sets the Font object to use for the cell.

Parameters:

value - The Font object to use for the cell.

getRow

public Row2 getRow()

Gets the Row2 that the cell is contained in.

Returns:

The Row2 that the cell is contained in.

getColumnIndex

public int getColumnIndex()

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

Returns:

The index of the Column2 in which the cell begins.

getColumnSpan

public int getColumnSpan()

Gets the number of columns that the cell spans.

Returns:

The number of columns that the cell spans.

setColumnSpan

public void setColumnSpan(int value)

Sets the number of columns that the cell spans.

Parameters:

value - The number of columns that the cell spans.

getRowSpan

public int getRowSpan()

Gets the number of rows that the cell spans.

Returns:

The number of rows that the cell spans.

setRowSpan

public void setRowSpan(int value)

Sets the number of rows that the cell spans.

Parameters:

value - The number of rows that the cell spans.

getWidth

public float getWidth()

Gets the width of the cell.

Returns:

The width of the cell.

getHeight

public float getHeight()

Gets the height of the cell.

Returns:

The height of the cell.

getBackgroundColor

public Color getBackgroundColor()

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

Returns:

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

setBackgroundColor

public void setBackgroundColor(Color value)

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

Parameters:

value - The Color object to use for the background of the cell.

getTextColor

public Color getTextColor()

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

Returns:

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

setTextColor

public void setTextColor(Color value)

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

Parameters:

value - The Color object to use for the text of the cell.

getAlign

public TextAlign getAlign()

Gets the TextAlign enumeration to use for the horizontal alignment of the text in the cell. Justify and FullJustify are applicable only for text.

Returns:

The TextAlign enumeration to use for the horizontal alignment of the text in the cell. Justify and FullJustify are applicable only for text.

setAlign

public void setAlign(TextAlign value)

Sets the TextAlign enumeration to use for the horizontal alignment of the text in the cell. Justify and FullJustify are applicable only for text.

Parameters:

value - The TextAlign enumeration to use for the horizontal alignment of the text in the cell. Justify and FullJustify are applicable only for text.

getVAlign

public VAlign getVAlign()

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

Returns:

The VAlign enumeration to use for the vertical alignment of the text in the cell.

setVAlign

public void setVAlign(VAlign value)

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

Parameters:

value - The VAlign enumeration to use for the vertical alignment of the text in the cell.

getAutoLeading

public java.lang.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(java.lang.Boolean value)

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

Parameters:

value - whether the leading of the cell should be calculated automatically.

getLeading

public float getLeading()

Gets the leading for the text of the cell.

Returns:

the leading for the text of the cell.

setLeading

public void setLeading(float value)

Sets the leading for the text of the cell.

Setting this method will automatically set the #setAutoLeading(InheritableBoolean value) method to false.

Parameters:

value - the leading for the text of the cell.

getParagraphIndent

public float getParagraphIndent()

Gets the paragraph indent for the paragraphs of the cell.

Returns:

the paragraph indent for the paragraphs of the cell.

setParagraphIndent

public void setParagraphIndent(float value)

Sets the paragraph indent for the paragraphs of the cell.

Parameters:

value - the paragraph indent for the paragraphs of the cell.

getParagraphSpacing

public float getParagraphSpacing()

Gets the paragraph spacing for the paragraphs of the cell.

Returns:

the paragraph spacing for the paragraphs of the cell.

setParagraphSpacing

public void setParagraphSpacing(float value)

Sets the paragraph spacing for the paragraphs of the cell.

Parameters:

value - the paragraph spacing for the paragraphs of the cell.

getRightToLeft

public java.lang.Boolean getRightToLeft()

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

Returns:

the right to left property of the cell.

setRightToLeft

public void setRightToLeft(java.lang.Boolean value)

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

Parameters:

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

getUnderline

public java.lang.Boolean getUnderline()

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

Returns:

whether the text in the cell will be underlined.

setUnderline

public void setUnderline(java.lang.Boolean value)

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

Parameters:

value - specifying whether the text in the cell will be underlined.

setTag

public void setTag(Tag value)

Sets the structure element of the cell.

Parameters:

value - the structure element of the cell.

getTag

public Tag getTag()

Gets the structure element of the cell.

Returns:

the structure element of the cell.

setTagOrder

public void setTagOrder(int value)

Sets the structure element order of the cell.

Parameters:

value - the structure element order of the cell.

getTagOrder

public int getTagOrder()

Gets the structure element order of the cell.

Returns:

the structure element order of the cell.