TableElement

Inheritance: java.lang.Object, com.aspose.pdf.tagged.logicalstructure.elements.Element, com.aspose.pdf.tagged.logicalstructure.elements.StructureElement, com.aspose.pdf.tagged.logicalstructure.elements.bls.BLSElement

public final class TableElement extends BLSElement

Represents Table structure element in logical structure.

Constructors

Constructor	Description
TableElement(TaggedContext taggedContext, IPdfPrimitive pdfEngineEntity)	constructor for internal usage only

Methods

Method	Description
getTable()
getBackgroundColor()	Gets or sets the table background color.
setBackgroundColor(Color value)	Gets or sets the table background color.
getBorder()	Gets or sets the table border.
setBorder(BorderInfo value)	Gets or sets the table border.
getAlignment()	Gets or sets the table alignment.
setAlignment(HorizontalAlignment value)	Gets or sets the table alignment.
getCornerStyle()	Gets or sets the styles of the border corners
setCornerStyle(int value)	Gets or sets the styles of the border corners
getBroken()	Gets or sets table vertical broken;
setBroken(int value)	Gets or sets table vertical broken;
getColumnAdjustment()	Gets or sets the table column adjustment.
setColumnAdjustment(int value)	Gets or sets the table column adjustment.
getColumnWidths()	Gets the column widths of the table.
setColumnWidths(String value)	Gets the column widths of the table.
getDefaultCellBorder()	Gets default cell border.
setDefaultCellBorder(BorderInfo value)	Gets default cell border.
getDefaultCellPadding()	Gets or sets the default cell padding.
setDefaultCellPadding(MarginInfo value)	Gets or sets the default cell padding.
getDefaultCellTextState()	Gets or sets the default cell text state.
setDefaultCellTextState(TextState value)	Gets or sets the default cell text state.
getDefaultColumnWidth()	Gets or sets default column width.
setDefaultColumnWidth(String value)	Gets or sets default column width.
isBroken()	Gets or sets the table is broken - will be truncated for next page.
setBroken(boolean value)	Gets or sets the table is broken - will be truncated for next page.
isBordersIncluded()	Gets or sets border included in column widhts.
setBordersIncluded(boolean value)	Gets or sets border included in column widhts.
getLeft()	Gets or sets the table left coordinate.
setLeft(float value)	Gets or sets the table left coordinate.
getTop()	Gets or sets the table top coordinate.
setTop(float value)	Gets or sets the table top coordinate.
getRepeatingColumnsCount()	Gets or sets the maximum columns count for table.
setRepeatingColumnsCount(int value)	Gets or sets the maximum columns count for table.
getRepeatingRowsCount()	Gets the first rows count repeated for several pages.
setRepeatingRowsCount(int value)	Gets the first rows count repeated for several pages.
getRepeatingRowsStyle()	Gets the style for repeating rows.
setRepeatingRowsStyle(TextState value)	Gets the style for repeating rows.
createTHead()	Creates TableTHeadElement and added it to current table.
createTBody()	Creates TableTHeadElement and added it to current table.
createTFoot()	Creates TableTFootElement and added it to current table.

TableElement(TaggedContext taggedContext, IPdfPrimitive pdfEngineEntity)

public TableElement(TaggedContext taggedContext, IPdfPrimitive pdfEngineEntity)

constructor for internal usage only

Parameters:

Parameter	Type	Description
taggedContext	TaggedContext	TaggedContext instance
pdfEngineEntity	IPdfPrimitive	internal instance

getTable()

public final Table getTable()

Returns: Table

getBackgroundColor()

public final Color getBackgroundColor()

Gets or sets the table background color.

Returns: Color - Color instance

setBackgroundColor(Color value)

public final void setBackgroundColor(Color value)

Gets or sets the table background color.

Parameters:

Parameter	Type	Description
value	Color	Color instance

getBorder()

public final BorderInfo getBorder()

Gets or sets the table border.

Returns: BorderInfo - BorderInfo instance

setBorder(BorderInfo value)

public final void setBorder(BorderInfo value)

Gets or sets the table border.

Parameters:

Parameter	Type	Description
value	BorderInfo	BorderInfo instance

getAlignment()

public final HorizontalAlignment getAlignment()

Gets or sets the table alignment.

Returns: HorizontalAlignment - HorizontalAlignment element

setAlignment(HorizontalAlignment value)

public final void setAlignment(HorizontalAlignment value)

Gets or sets the table alignment.

Parameters:

Parameter	Type	Description
value	HorizontalAlignment	HorizontalAlignment element

getCornerStyle()

public final int getCornerStyle()

Gets or sets the styles of the border corners

Returns: int - BorderCornerStyle element

setCornerStyle(int value)

public final void setCornerStyle(int value)

Gets or sets the styles of the border corners

Parameters:

Parameter	Type	Description
value	int	BorderCornerStyle element

getBroken()

public final int getBroken()

Gets or sets table vertical broken;

Returns: int - TableBroken element

setBroken(int value)

public final void setBroken(int value)

Gets or sets table vertical broken;

Parameters:

Parameter	Type	Description
value	int	TableBroken element

getColumnAdjustment()

public final int getColumnAdjustment()

Gets or sets the table column adjustment.

Returns: int - ColumnAdjustment element

setColumnAdjustment(int value)

public final void setColumnAdjustment(int value)

Gets or sets the table column adjustment.

Parameters:

Parameter	Type	Description
value	int	ColumnAdjustment element

getColumnWidths()

public final String getColumnWidths()

Gets the column widths of the table.

Returns: java.lang.String - String value

setColumnWidths(String value)

public final void setColumnWidths(String value)

Gets the column widths of the table.

Parameters:

Parameter	Type	Description
value	java.lang.String	String value

getDefaultCellBorder()

public final BorderInfo getDefaultCellBorder()

Gets default cell border.

Returns: BorderInfo - BorderInfo instance

setDefaultCellBorder(BorderInfo value)

public final void setDefaultCellBorder(BorderInfo value)

Gets default cell border.

Parameters:

Parameter	Type	Description
value	BorderInfo	BorderInfo instance

getDefaultCellPadding()

public final MarginInfo getDefaultCellPadding()

Gets or sets the default cell padding.

Returns: MarginInfo - MarginInfo instance

setDefaultCellPadding(MarginInfo value)

public final void setDefaultCellPadding(MarginInfo value)

Gets or sets the default cell padding.

Parameters:

Parameter	Type	Description
value	MarginInfo	MarginInfo instance

getDefaultCellTextState()

public final TextState getDefaultCellTextState()

Gets or sets the default cell text state.

Returns: TextState - TextState instance

setDefaultCellTextState(TextState value)

public final void setDefaultCellTextState(TextState value)

Gets or sets the default cell text state.

Parameters:

Parameter	Type	Description
value	TextState	TextState instance

getDefaultColumnWidth()

public final String getDefaultColumnWidth()

Gets or sets default column width.

Returns: java.lang.String - String value

setDefaultColumnWidth(String value)

public final void setDefaultColumnWidth(String value)

Gets or sets default column width.

Parameters:

Parameter	Type	Description
value	java.lang.String	String value

isBroken()

public final boolean isBroken()

Gets or sets the table is broken - will be truncated for next page.

Returns: boolean - boolean value

setBroken(boolean value)

public final void setBroken(boolean value)

Gets or sets the table is broken - will be truncated for next page.

Parameters:

Parameter	Type	Description
value	boolean	boolean value

isBordersIncluded()

public final boolean isBordersIncluded()

Gets or sets border included in column widhts.

Returns: boolean - boolean value

setBordersIncluded(boolean value)

public final void setBordersIncluded(boolean value)

Gets or sets border included in column widhts.

Parameters:

Parameter	Type	Description
value	boolean	boolean value

getLeft()

public final float getLeft()

Gets or sets the table left coordinate.

Returns: float - float value

setLeft(float value)

public final void setLeft(float value)

Gets or sets the table left coordinate.

Parameters:

Parameter	Type	Description
value	float	float value

getTop()

public final float getTop()

Gets or sets the table top coordinate.

Returns: float - float value

setTop(float value)

public final void setTop(float value)

Gets or sets the table top coordinate.

Parameters:

Parameter	Type	Description
value	float	float value

getRepeatingColumnsCount()

public final int getRepeatingColumnsCount()

Gets or sets the maximum columns count for table.

Returns: int - int value

setRepeatingColumnsCount(int value)

public final void setRepeatingColumnsCount(int value)

Gets or sets the maximum columns count for table.

Parameters:

Parameter	Type	Description
value	int	int value

getRepeatingRowsCount()

public final int getRepeatingRowsCount()

Gets the first rows count repeated for several pages.

Returns: int - int value

setRepeatingRowsCount(int value)

public final void setRepeatingRowsCount(int value)

Gets the first rows count repeated for several pages.

Parameters:

Parameter	Type	Description
value	int	int value

getRepeatingRowsStyle()

public final TextState getRepeatingRowsStyle()

Gets the style for repeating rows.

Returns: TextState - TextState instance

setRepeatingRowsStyle(TextState value)

public final void setRepeatingRowsStyle(TextState value)

Gets the style for repeating rows.

Parameters:

Parameter	Type	Description
value	TextState	TextState instance

createTHead()

public final TableTHeadElement createTHead()

Creates TableTHeadElement and added it to current table.

Returns: TableTHeadElement - Created structure element.

createTBody()

public final TableTBodyElement createTBody()

Creates TableTHeadElement and added it to current table.

Returns: TableTBodyElement - Created structure element.

createTFoot()

public final TableTFootElement createTFoot()

Creates TableTFootElement and added it to current table.

Returns: TableTFootElement - Created structure element.