Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject

Field Summary

Modifier and Type	Field and Description
protected static final String	COL_SPAN
protected static final String	HEADERS
public static final String	OWNER_TABLE standard attribute owner: Table
protected static final String	ROW_SPAN
protected static final String	SCOPE
public static final String	SCOPE_BOTH Scope: Both
public static final String	SCOPE_COLUMN Scope: Column
public static final String	SCOPE_ROW Scope: Row
protected static final String	SUMMARY

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject:: UNSPECIFIED

Constructor Summary

Access	Constructor and Description
public	PDTableAttributeObject() Default constructor.
public	PDTableAttributeObject(COSDictionary the dictionary dictionary) Creates a new Table attribute object with a given dictionary.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the column span getColSpan() Gets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).
public String[]	Returns: the headers. getHeaders() Gets the headers (Headers).
public int	Returns: the row span getRowSpan() Gets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).
public String	Returns: the scope getScope() Gets the scope (Scope).
public String	Returns: the summary getSummary() Gets the summary of the table’s purpose and structure.
public void	setColSpan(int the column span colSpan) Sets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).
public void	setHeaders(String[] the headers headers) Sets the headers (Headers).
public void	setRowSpan(int the row span rowSpan) Sets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).
public void	setScope(String the scope scope) Sets the scope (Scope).
public void	setSummary(String the summary summary) Sets the summary of the table’s purpose and structure.
public String	toString() Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString. Returns a string representation of the object.

Field Detail

COL_SPAN	back to summary
protected static final String COL_SPAN

HEADERS	back to summary
protected static final String HEADERS

OWNER_TABLE	back to summary
public static final String OWNER_TABLE standard attribute owner: Table

ROW_SPAN	back to summary
protected static final String ROW_SPAN

SCOPE	back to summary
protected static final String SCOPE

SCOPE_BOTH	back to summary
public static final String SCOPE_BOTH Scope: Both

SCOPE_COLUMN	back to summary
public static final String SCOPE_COLUMN Scope: Column

SCOPE_ROW	back to summary
public static final String SCOPE_ROW Scope: Row

SUMMARY	back to summary
protected static final String SUMMARY

Constructor Detail

PDTableAttributeObject	back to summary
public PDTableAttributeObject() Default constructor.

PDTableAttributeObject	back to summary
public PDTableAttributeObject(COSDictionary dictionary) Creates a new Table attribute object with a given dictionary. Parameters dictionary:COSDictionary the dictionary

PDTableAttributeObject

back to summary

public PDTableAttributeObject(COSDictionary dictionary)

Creates a new Table attribute object with a given dictionary.

Parameters

dictionary:COSDictionary: the dictionary

Method Detail

getColSpan	back to summary
public int getColSpan() Gets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan). The default value is 1. Returns:int the column span

getColSpan

back to summary

public int getColSpan()

Gets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan). The default value is 1.

Returns:int: the column span

getHeaders back to summary

getHeaders	back to summary
public String[] getHeaders() Gets the headers (Headers). An array of byte strings, where each string shall be the element identifier (see the `org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement#getElementIdentifier()`) for a TH structure element that shall be used as a header associated with this cell. Returns:String[] the headers.

public String[] getHeaders()

Gets the headers (Headers). An array of byte strings, where each string shall be the element identifier (see the org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement#getElementIdentifier()) for a TH structure element that shall be used as a header associated with this cell.

Returns:String[]: the headers.

getRowSpan	back to summary
public int getRowSpan() Gets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan). The default value is 1. Returns:int the row span

getRowSpan

back to summary

public int getRowSpan()

Gets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan). The default value is 1.

Returns:int: the row span

getScope	back to summary
public String getScope() Gets the scope (Scope). It shall reflect whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it. Returns:String the scope

getScope

back to summary

public String getScope()

Gets the scope (Scope). It shall reflect whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it.

Returns:String: the scope

getSummary	back to summary
public String getSummary() Gets the summary of the table’s purpose and structure. Returns:String the summary

getSummary

back to summary

public String getSummary()

Gets the summary of the table’s purpose and structure.

Returns:String: the summary

setColSpan	back to summary
public void setColSpan(int colSpan) Sets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan). Parameters colSpan:int the column span

setColSpan

back to summary

public void setColSpan(int colSpan)

Sets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).

Parameters

colSpan:int: the column span

setHeaders back to summary

setHeaders	back to summary
public void setHeaders(String[] headers) Sets the headers (Headers). An array of byte strings, where each string shall be the element identifier (see the `org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement#getElementIdentifier()`) for a TH structure element that shall be used as a header associated with this cell. Parameters headers:String[] the headers

public void setHeaders(String[] headers)

Sets the headers (Headers). An array of byte strings, where each string shall be the element identifier (see the org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement#getElementIdentifier()) for a TH structure element that shall be used as a header associated with this cell.

Parameters

headers:String[]: the headers

setRowSpan	back to summary
public void setRowSpan(int rowSpan) Sets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan). Parameters rowSpan:int the row span

setRowSpan

back to summary

public void setRowSpan(int rowSpan)

Sets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).

Parameters

rowSpan:int: the row span

setScope back to summary

setScope	back to summary
public void setScope(String scope) Sets the scope (Scope). It shall reflect whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it. The value shall be one of the following: `SCOPE_ROW`, `SCOPE_COLUMN`, or `SCOPE_BOTH`. Parameters scope:String the scope

public void setScope(String scope)

Sets the scope (Scope). It shall reflect whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it. The value shall be one of the following:

Parameters

scope:String: the scope

setSummary	back to summary
public void setSummary(String summary) Sets the summary of the table’s purpose and structure. Parameters summary:String the summary

setSummary

back to summary

public void setSummary(String summary)

Sets the summary of the table’s purpose and structure.

Parameters

summary:String: the summary

toString back to summary

toString	back to summary
public String toString() Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class PDTableAttributeObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail