com.cete.dynamicpdf.pageelements
Class Table

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.RotatingPageElement
              com.cete.dynamicpdf.pageelements.Table

All Implemented Interfaces:

IArea, ICoordinate

Deprecated. As of DynamicPDF v6.0.0, replaced by Table2

public class Table
extends RotatingPageElement
implements IArea, ICoordinate

This class can be used to create tables. A table must contain at least one Column and one Row with at least one Cell in that Row. Formatting of each cell in the table is done in a hierarchical manner in that a Cell's formatting take precedent over a Row's formatting which in term takes precedent over a Table's formatting. The column object contains no formatting information. Using the Tables getOverflowColumns and getOverflowRows methods you can allow your table to easily flow onto other pages.

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

Constructor Summary

Table(float x, float y, float width, float height)
Deprecated. Initializes a new instance of the Table.

Table(float x, float y, float width, float height, Font font, float size)
Deprecated. Initializes a new instance of the Table.

Table(float x, float y, float width, float height, Font font, float size, Color textColor, Color backColor)
Deprecated. Initializes a new instance of the Table.

Method Summary

protected void	drawRotated(PageWriter writer) Deprecated. Draws the table to the given PageWriter object.
TextAlign	getAlign() Deprecated. Gets the Align object to use for the horizontal alignment of the text in the table.
Color	getBackgroundColor() Deprecated. Gets the Color object to use for the background of the table.
Color	getBorderColor() Deprecated. Gets the Color object to use for the borders of the table.
float	getBorderWidth() Deprecated. Gets the width of the border on the table.
ColumnList	getColumns() Deprecated. Sets the RowList object contained in the table.
Font	getFont() Deprecated. Gets the Font object to use for the table.
float	getFontSize() Deprecated. Gets the font size of the text in the table.
float	getHeight() Deprecated. Gets the height of the table.
Table	getOverflowColumns() Deprecated. Returns a Table object containing the overflow columns.
Table	getOverflowColumns(float x, float y) Deprecated. Returns a Table object containing the overflow columns.
Table	getOverflowColumns(float x, float y, float width, float height) Deprecated. Returns a Table object containing the overflow columns.
Table	getOverflowRows() Deprecated. Returns a Table object containing the overflow rows.
Table	getOverflowRows(float x, float y) Deprecated. Returns a Table object containing the overflow rows.
Table	getOverflowRows(float x, float y, float width, float height) Deprecated. Returns a Table object containing the overflow rows.
float	getPadding() Deprecated. Gets the padding of the cells in the table.
int	getRepeatColumnHeaderCount() Deprecated. Gets the number of initial rows in the table that should also be drawn as the first rows on all subsequent row overflow tables.
int	getRepeatRowHeaderCount() Deprecated. Gets the number of columns that will be repeated as the row header.
float	getRequiredHeight() Deprecated. Returns the height required to vertically fit the entire table on the page.
float	getRequiredWidth() Deprecated. Returns the width required to horizontally fit the entire table on the page.
RowList	getRows() Deprecated. Gets the RowList object contained in the table.
Color	getTextColor() Deprecated. Gets the Color object to use for the text of the table.
VAlign	getVAlign() Deprecated. Gets the VAlign object to use for the vertical alignment of the text in the Table.
int	getVisibleColumnCount() Deprecated. Returns the number of columns that will be displayed in the current table.
float	getVisibleHeight() Deprecated. Returns the actual height of the table that will be placed on the page.
int	getVisibleRowCount() Deprecated. Returns the number of rows that will be displayed in the current table.
float	getVisibleWidth() Deprecated. Returns the actual width of the table that will be placed on the page.
float	getWidth() Deprecated. Gets the width of the table.
float	getX() Deprecated. Gets the x coordinate of the table.
float	getY() Deprecated. Gets the y coordinate of the table.
boolean	hasOverflowColumns() Deprecated. Returns a value indicating if there are columns remaining that will not be drawn to the table.
boolean	hasOverflowRows() Deprecated. Returns a value indicating if there are rows remaining that will not be drawn to the table.
void	setAlign(TextAlign value) Deprecated. Sets the Align object to use for the horizontal alignment of the text in the table.
void	setBackgroundColor(Color value) Deprecated. Sets the Color object to use for the background of the table.
void	setBorderColor(Color value) Deprecated. Sets the Color object to use for the borders of the table.
void	setBorderWidth(float value) Deprecated. Sets the width of the border on the table.
void	setFont(Font value) Deprecated. Sets the Font object to use for the table.
void	setFontSize(float value) Deprecated. Gets the font size of the text in the table.
void	setHeight(float value) Deprecated. Sets the height of the table.
void	setPadding(float value) Deprecated. Sets the padding of the cells in the table.
void	setRepeatColumnHeaderCount(int value) Deprecated. Sets the number of initial rows in the table that should also be drawn as the first rows on all subsequent row overflow tables.
void	setRepeatRowHeaderCount(int value) Deprecated. Sets the number of columns that will be repeated as the row header.
void	setTextColor(Color value) Deprecated. Sets the Color object to use for the text of the table.
void	setVAlign(VAlign value) Deprecated. Sets the VAlign object to use for the vertical alignment of the text in the Table.
void	setWidth(float value) Deprecated. Sets the width of the table.
void	setX(float value) Deprecated. Sets the x coordinate of the table.
void	setY(float value) Deprecated. Sets the y coordinate of the table.

Methods inherited from class com.cete.dynamicpdf.pageelements.RotatingPageElement

draw, getAngle, setAngle

Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement

getTag, getTagOrder, setTag, setTagOrder

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table(float x,
             float y,
             float width,
             float height)

Deprecated.

Initializes a new instance of the Table.

Parameters:

x - X coordinate of the table.

y - Y coordinate of the table.

width - Width of the table.

height - Height of the table.

Table

public Table(float x,
             float y,
             float width,
             float height,
             Font font,
             float size)

Deprecated.

Initializes a new instance of the Table.

Parameters:

x - X coordinate of the table.

y - Y coordinate of the table.

width - Width of the table.

height - Height of the table.

font - Font for the text in the table.

size - Font size for the text in the table.

Table

public Table(float x,
             float y,
             float width,
             float height,
             Font font,
             float size,
             Color textColor,
             Color backColor)

Deprecated.

Initializes a new instance of the Table.

Parameters:

x - X coordinate of the table.

y - Y coordinate of the table.

width - Width of the table.

height - Height of the table.

font - Font for the text in the table.

size - Size of the font.

textColor - Color of the text in the table.

backColor - Background Color of the table.

Method Detail

getX

public float getX()

Deprecated.

Gets the x coordinate of the table.

Specified by:

getX in interface ICoordinate

Overrides:

getX in class RotatingPageElement

Returns:

the x coordinate of the table.

setX

public void setX(float value)

Deprecated.

Sets the x coordinate of the table.

Specified by:

setX in interface ICoordinate

Overrides:

setX in class RotatingPageElement

Parameters:

value - the x coordinate of the table.

getY

public float getY()

Deprecated.

Gets the y coordinate of the table.

Specified by:

getY in interface ICoordinate

Overrides:

getY in class RotatingPageElement

Returns:

the y coordinate of the table.

setY

public void setY(float value)

Deprecated.

Sets the y coordinate of the table.

Specified by:

setY in interface ICoordinate

Overrides:

setY in class RotatingPageElement

Parameters:

value - the y coordinate of the table.

getWidth

public float getWidth()

Deprecated.

Gets the width of the table.

Specified by:

getWidth in interface IArea

Returns:

the width coordinate of the table.

setWidth

public void setWidth(float value)

Deprecated.

Sets the width of the table.

Specified by:

setWidth in interface IArea

Parameters:

value - the width coordinate of the table.

getHeight

public float getHeight()

Deprecated.

Gets the height of the table.

Specified by:

getHeight in interface IArea

Overrides:

getHeight in class RotatingPageElement

Returns:

the height of the table.

setHeight

public void setHeight(float value)

Deprecated.

Sets the height of the table.

Specified by:

setHeight in interface IArea

Overrides:

setHeight in class RotatingPageElement

Parameters:

value - the height of the table.

getFont

public Font getFont()

Deprecated.

Gets the Font object to use for the table.

Returns:

the fomt of the table.

See Also:

Font

setFont

public void setFont(Font value)

Deprecated.

Sets the Font object to use for the table.

Parameters:

value - the font of the table.

See Also:

Font

getFontSize

public float getFontSize()

Deprecated.

Gets the font size of the text in the table.

Returns:

the font size of the table.

setFontSize

public void setFontSize(float value)

Deprecated.

Gets the font size of the text in the table.

Parameters:

value - the fomt size of the table.

getTextColor

public Color getTextColor()

Deprecated.

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

Returns:

the text color of the table.

See Also:

Color

setTextColor

public void setTextColor(Color value)

Deprecated.

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

Parameters:

value - the text color of the table.

See Also:

Color

getBackgroundColor

public Color getBackgroundColor()

Deprecated.

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

Returns:

the background color of the table.

See Also:

Color

setBackgroundColor

public void setBackgroundColor(Color value)

Deprecated.

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

Parameters:

value - the background color of the table.

See Also:

Color

getAlign

public TextAlign getAlign()

Deprecated.

Gets the Align object to use for the horizontal alignment of the text in the table.

Returns:

the text alignment of the table.

See Also:

TextAlign

setAlign

public void setAlign(TextAlign value)

Deprecated.

Sets the Align object to use for the horizontal alignment of the text in the table.

Parameters:

value - the text alignment of the table.

See Also:

TextAlign

getVAlign

public VAlign getVAlign()

Deprecated.

Gets the VAlign object to use for the vertical alignment of the text in the Table.

Returns:

the vertical alignment of the text in the Table.

See Also:

VAlign

setVAlign

public void setVAlign(VAlign value)

Deprecated.

Sets the VAlign object to use for the vertical alignment of the text in the Table.

Parameters:

value - the vertical alignment of the text in the Table.

See Also:

VAlign

getBorderWidth

public float getBorderWidth()

Deprecated.

Gets the width of the border on the table.

Returns:

the width of the border on the table.

setBorderWidth

public void setBorderWidth(float value)

Deprecated.

Sets the width of the border on the table.

Parameters:

value - the width of the border on the table.

getBorderColor

public Color getBorderColor()

Deprecated.

Gets the Color object to use for the borders of the table.

Returns:

the color of the border on the table.

See Also:

Color

setBorderColor

public void setBorderColor(Color value)

Deprecated.

Sets the Color object to use for the borders of the table.

Parameters:

value - the color of the border on the table.

See Also:

Color

getPadding

public float getPadding()

Deprecated.

Gets the padding of the cells in the table.

Returns:

the padding of the cells in the table.

setPadding

public void setPadding(float value)

Deprecated.

Sets the padding of the cells in the table.

Parameters:

value - the padding of the cells in the table.

getRepeatRowHeaderCount

public int getRepeatRowHeaderCount()

Deprecated.

Gets the number of columns that will be repeated as the row header. This is set to 1 by default.

Returns:

the number of columns that will be repeated as the row header.

setRepeatRowHeaderCount

public void setRepeatRowHeaderCount(int value)

Deprecated.

Sets the number of columns that will be repeated as the row header. This number is only considered if RepeatColumnHeader is set to true. This is set to 1 by default.

Parameters:

value - the row repeat header count.

getRepeatColumnHeaderCount

public int getRepeatColumnHeaderCount()

Deprecated.

Gets the number of initial rows in the table that should also be drawn as the first rows on all subsequent row overflow tables. This is set to 0 by default.

Returns:

the row repeat header count.

setRepeatColumnHeaderCount

public void setRepeatColumnHeaderCount(int value)

Deprecated.

Sets the number of initial rows in the table that should also be drawn as the first rows on all subsequent row overflow tables. This is set to 0 by default.

Parameters:

value - the column repeat header count.

getRows

public RowList getRows()

Deprecated.

Gets the RowList object contained in the table.

Returns:

the row list.

See Also:

RowList

getColumns

public ColumnList getColumns()

Deprecated.

Sets the RowList object contained in the table.

Returns:

the column list.

See Also:

ColumnList

getOverflowRows

public Table getOverflowRows()

Deprecated.

Returns a Table object containing the overflow rows. View Example

Returns:

a Table object.

See Also:

Table

getOverflowRows

public Table getOverflowRows(float x,
                             float y)

Deprecated.

Returns a Table object containing the overflow rows. View Example

Parameters:

x - X coordinate of the new table.

y - Y coordinate of the new table.

Returns:

A Table object.

See Also:

Table

getOverflowRows

public Table getOverflowRows(float x,
                             float y,
                             float width,
                             float height)

Deprecated.

Returns a Table object containing the overflow rows. View Example

Parameters:

x - X coordinate of the new table.

y - Y coordinate of the new table.

width - Width of the new table.

height - Height of the new table.

Returns:

A Table object.

See Also:

Table

getOverflowColumns

public Table getOverflowColumns()

Deprecated.

Returns a Table object containing the overflow columns. View Example

Returns:

a Table

getOverflowColumns

public Table getOverflowColumns(float x,
                                float y)

Deprecated.

Returns a Table object containing the overflow columns. View Example

Parameters:

x - X coordinate of the new table.

y - Y coordinate of the new table.

Returns:

a Table

getOverflowColumns

public Table getOverflowColumns(float x,
                                float y,
                                float width,
                                float height)

Deprecated.

Returns a Table object containing the overflow columns. View Example

Parameters:

x - X coordinate of the new table.

y - Y coordinate of the new table.

width - Width of the new table.

height - Height of the new table.

Returns:

a Table

getVisibleWidth

public float getVisibleWidth()

Deprecated.

Returns the actual width of the table that will be placed on the page.

Returns:

the actual width of the table that will be placed on the page.

getVisibleHeight

public float getVisibleHeight()

Deprecated.

Returns the actual height of the table that will be placed on the page.

Returns:

the actual height of the table that will be placed on the page.

getRequiredWidth

public float getRequiredWidth()

Deprecated.

Returns the width required to horizontally fit the entire table on the page.

Returns:

float The width to fit the entire table on the page horizontally.

getRequiredHeight

public float getRequiredHeight()

Deprecated.

Returns the height required to vertically fit the entire table on the page.

Returns:

The height to fit the entire table on the page vertically.

hasOverflowRows

public boolean hasOverflowRows()

Deprecated.

Returns a value indicating if there are rows remaining that will not be drawn to the table.

Returns:

boolean value indication whether or not overflow rows exists.

hasOverflowColumns

public boolean hasOverflowColumns()

Deprecated.

Returns a value indicating if there are columns remaining that will not be drawn to the table.

Returns:

boolean value indication whether or not overflow columns exists.

getVisibleRowCount

public int getVisibleRowCount()

Deprecated.

Returns the number of rows that will be displayed in the current table.

Returns:

The number are rows that will display.

getVisibleColumnCount

public int getVisibleColumnCount()

Deprecated.

Returns the number of columns that will be displayed in the current table.

Returns:

The number are columns that will display.

drawRotated

protected void drawRotated(PageWriter writer)

Deprecated.

Draws the table to the given PageWriter object.

Specified by:

drawRotated in class RotatingPageElement

Parameters:

writer - PageWriter object to receive the table's output.

See Also:

PageWriter