Class PDTableAttributeObject
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
-
- org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
- org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
- org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
- All Implemented Interfaces:
COSObjectable
public class PDTableAttributeObject extends PDStandardAttributeObject
A Table attribute object.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
COL_SPAN
protected static java.lang.String
HEADERS
static java.lang.String
OWNER_TABLE
standard attribute owner: Tableprotected static java.lang.String
ROW_SPAN
protected static java.lang.String
SCOPE
static java.lang.String
SCOPE_BOTH
Scope: Bothstatic java.lang.String
SCOPE_COLUMN
Scope: Columnstatic java.lang.String
SCOPE_ROW
Scope: Rowprotected static java.lang.String
SUMMARY
-
Fields inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
UNSPECIFIED
-
-
Constructor Summary
Constructors Constructor Description PDTableAttributeObject()
Default constructor.PDTableAttributeObject(COSDictionary dictionary)
Creates a new Table attribute object with a given dictionary.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getColSpan()
Gets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).java.lang.String[]
getHeaders()
Gets the headers (Headers).int
getRowSpan()
Gets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).java.lang.String
getScope()
Gets the scope (Scope).java.lang.String
getSummary()
Gets the summary of the table’s purpose and structure.void
setColSpan(int colSpan)
Sets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).void
setHeaders(java.lang.String[] headers)
Sets the headers (Headers).void
setRowSpan(int rowSpan)
Sets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).void
setScope(java.lang.String scope)
Sets the scope (Scope).void
setSummary(java.lang.String summary)
Sets the summary of the table’s purpose and structure.java.lang.String
toString()
-
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
getArrayOfString, getColor, getColorOrFourColors, getInteger, getName, getName, getNameOrArrayOfName, getNumber, getNumber, getNumberOrArrayOfNumber, getNumberOrName, getString, isSpecified, setArrayOfName, setArrayOfNumber, setArrayOfString, setColor, setFourColors, setInteger, setName, setNumber, setNumber, setString
-
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
arrayToString, arrayToString, create, getOwner, isEmpty, notifyChanged, potentiallyNotifyChanged, setOwner, setStructureElement
-
Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
equals, getCOSObject, hashCode
-
-
-
-
Field Detail
-
OWNER_TABLE
public static final java.lang.String OWNER_TABLE
standard attribute owner: Table- See Also:
- Constant Field Values
-
ROW_SPAN
protected static final java.lang.String ROW_SPAN
- See Also:
- Constant Field Values
-
COL_SPAN
protected static final java.lang.String COL_SPAN
- See Also:
- Constant Field Values
-
HEADERS
protected static final java.lang.String HEADERS
- See Also:
- Constant Field Values
-
SCOPE
protected static final java.lang.String SCOPE
- See Also:
- Constant Field Values
-
SUMMARY
protected static final java.lang.String SUMMARY
- See Also:
- Constant Field Values
-
SCOPE_BOTH
public static final java.lang.String SCOPE_BOTH
Scope: Both- See Also:
- Constant Field Values
-
SCOPE_COLUMN
public static final java.lang.String SCOPE_COLUMN
Scope: Column- See Also:
- Constant Field Values
-
SCOPE_ROW
public static final java.lang.String SCOPE_ROW
Scope: Row- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PDTableAttributeObject
public PDTableAttributeObject()
Default constructor.
-
PDTableAttributeObject
public PDTableAttributeObject(COSDictionary dictionary)
Creates a new Table attribute object with a given dictionary.- Parameters:
dictionary
- the dictionary
-
-
Method Detail
-
getRowSpan
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:
- the row span
-
setRowSpan
public void setRowSpan(int rowSpan)
Sets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).- Parameters:
rowSpan
- the row span
-
getColSpan
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:
- the column span
-
setColSpan
public void setColSpan(int colSpan)
Sets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).- Parameters:
colSpan
- the column span
-
getHeaders
public java.lang.String[] getHeaders()
Gets the headers (Headers). An array of byte strings, where each string shall be the element identifier (see thePDStructureElement.getElementIdentifier()
) for a TH structure element that shall be used as a header associated with this cell.- Returns:
- the headers.
-
setHeaders
public void setHeaders(java.lang.String[] headers)
Sets the headers (Headers). An array of byte strings, where each string shall be the element identifier (see thePDStructureElement.getElementIdentifier()
) for a TH structure element that shall be used as a header associated with this cell.- Parameters:
headers
- the headers
-
getScope
public java.lang.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:
- the scope
-
setScope
public void setScope(java.lang.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
, orSCOPE_BOTH
.
- Parameters:
scope
- the scope
-
getSummary
public java.lang.String getSummary()
Gets the summary of the table’s purpose and structure.- Returns:
- the summary
-
setSummary
public void setSummary(java.lang.String summary)
Sets the summary of the table’s purpose and structure.- Parameters:
summary
- the summary
-
toString
public java.lang.String toString()
- Overrides:
toString
in classPDAttributeObject
-
-