com.itextpdf.layout.element

Class Cell

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

com.itextpdf.layout.element.BlockElement<Cell>

com.itextpdf.layout.element.Cell

All Implemented Interfaces:

IAccessibleElement, IBlockElement, IElement, IPropertyContainer

public class Cell
extends BlockElement<Cell>

A Cell is one piece of data in an enclosing grid, the Table. This object is a BlockElement, giving it a number of visual layout properties. A cell can act as a container for a number of layout elements; it can only contain other BlockElement objects or images. Other types of layout elements must be wrapped in a BlockElement.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfName	role
protected AccessibilityProperties	tagProperties

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor and Description
Cell() Creates a cell.
Cell(int rowspan, int colspan) Creates a cell which takes a custom amount of cell spaces in the table.

Method Summary

Modifier and Type	Method and Description
Cell	add(IBlockElement element) Adds any block element to the cell's contents.
Cell	add(Image element) Adds an image to the cell's contents.
Cell	add(String content) Directly adds a String of text to this cell.
Cell	clone(boolean includeContent) Clones a cell with its position, properties, and optionally its contents.
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
int	getCol() Gets the number of the column in which the cell is located.
int	getColspan() Gets the colspan of the cell.
T1	getDefaultProperty(int property) Gets the default property from this entity.
IRenderer	getRenderer() Gets a cell renderer for this element.
PdfName	getRole() Gets the element's role.
int	getRow() Gets the number of the row in which the cell is located.
int	getRowspan() Gets the rowspan of the cell.
protected IRenderer	makeNewRenderer()
void	setRole(PdfName role) Sets the element's role.
String	toString()
protected Cell	updateCellIndexes(int row, int col, int numberOfColumns)

Methods inherited from class com.itextpdf.layout.element.BlockElement

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, isKeepTogether, isKeepWithNext, setHeight, setKeepTogether, setKeepWithNext, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setRotationAngle, setRotationAngle, setSpacingRatio, setVerticalAlignment

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, hasProperty, isEmpty, propagateArtifactRoleToChildElements, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getHeight, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getWidth, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBaseDirection, setBold, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFont, setFontColor, setFontColor, setFontKerning, setFontScript, setFontSize, setHeight, setHeightPercent, setHorizontalAlignment, setHyphenation, setItalic, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setWidth, setWidth, setWidthPercent, setWordSpacing

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Field Detail

role

protected PdfName role

tagProperties

protected AccessibilityProperties tagProperties

Constructor Detail

Cell

public Cell(int rowspan,
            int colspan)

Creates a cell which takes a custom amount of cell spaces in the table.

Parameters:

rowspan - the number of rows this cell must occupy. Negative numbers will make the argument default to 1.

colspan - the number of columns this cell must occupy. Negative numbers will make the argument default to 1.

Cell

public Cell()

Creates a cell.

Method Detail

getRenderer

public IRenderer getRenderer()

Gets a cell renderer for this element. Note that this method can be called more than once. By default each element should define its own renderer, but the renderer can be overridden by AbstractElement.setNextRenderer(IRenderer) method call.

Specified by:

getRenderer in interface IElement

Overrides:

getRenderer in class AbstractElement<Cell>

Returns:

a cell renderer for this element

getRow

public int getRow()

Gets the number of the row in which the cell is located.

Returns:

the row number

getCol

public int getCol()

Gets the number of the column in which the cell is located.

Returns:

the column number

getRowspan

public int getRowspan()

Gets the rowspan of the cell.

Returns:

the rowspan

getColspan

public int getColspan()

Gets the colspan of the cell.

Returns:

the colspan

add

public Cell add(IBlockElement element)

Adds any block element to the cell's contents.

Parameters:

element - a BlockElement

Returns:

this Element

add

public Cell add(Image element)

Adds an image to the cell's contents.

Parameters:

element - an Image

Returns:

this Element

add

public Cell add(String content)

Directly adds a String of text to this cell. The content is wrapped in a layout element.

Parameters:

content - a String

Returns:

this Element

clone

public Cell clone(boolean includeContent)

Clones a cell with its position, properties, and optionally its contents.

Parameters:

includeContent - whether or not to also include the contents of the cell.

Returns:

a clone of this Element

getDefaultProperty

public  T1 getDefaultProperty(int property)

Description copied from interface: IPropertyContainer

Gets the default property from this entity.

Specified by:

getDefaultProperty in interface IPropertyContainer

Overrides:

getDefaultProperty in class BlockElement<Cell>

Type Parameters:

T1 - the return type associated with the property

Parameters:

property - the property to be retrieved

Returns:

the default property value. If the default property is not defined, null will be returned

toString

public String toString()

Overrides:

toString in class Object

getRole

public PdfName getRole()

Description copied from interface: IAccessibleElement

Gets the element's role.

Returns:

a PdfName containing the name of the role

setRole

public void setRole(PdfName role)

Description copied from interface: IAccessibleElement

Sets the element's role.

Parameters:

role - the new role which the IAccessibleElement should take

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties.

Returns:

a properties wrapper object specific to a tagged element in Tagged PDF

makeNewRenderer

protected IRenderer makeNewRenderer()

Specified by:

makeNewRenderer in class AbstractElement<Cell>

updateCellIndexes

protected Cell updateCellIndexes(int row,
                                 int col,
                                 int numberOfColumns)