Package org.apache.poi.xssf.usermodel
Class XSSFTableColumn
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFTableColumn
A table column of an
XSSFTable
. Use XSSFTable.createColumn(java.lang.String)
to
create new table columns.- Since:
- 4.0.0
- Author:
- Leonard Kappe
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
XSSFTableColumn
(XSSFTable table, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTTableColumn ctTableColumn) Create a new table column. -
Method Summary
Modifier and TypeMethodDescriptionint
Get the column's position in its table, staring with zero from left to right.long
getId()
Get the identifier of this column, which is is unique per table.getName()
Get the name of the column, which is is unique per table.getTable()
Get the table which contains this columnGet the XmlColumnPr (XML column properties) if this column has an XML mapping.void
setId
(long columnId) Set the identifier of this column, which must be unique per table.void
Get the name of the column, which is is unique per table.
-
Constructor Details
-
Method Details
-
getTable
Get the table which contains this column- Returns:
- the table containing this column
- Since:
- 4.0.0
-
getId
public long getId()Get the identifier of this column, which is is unique per table.- Returns:
- the column id
- Since:
- 4.0.0
-
setId
public void setId(long columnId) Set the identifier of this column, which must be unique per table. It is up to the caller to enforce the uniqueness of the id.- Since:
- 4.0.0
-
getName
Get the name of the column, which is is unique per table.- Returns:
- the column name
- Since:
- 4.0.0
-
setName
Get the name of the column, which is is unique per table.- Since:
- 4.0.0
-
getXmlColumnPr
Get the XmlColumnPr (XML column properties) if this column has an XML mapping.- Returns:
- the XmlColumnPr or
null
if this column has no XML mapping - Since:
- 4.0.0
-
getColumnIndex
public int getColumnIndex()Get the column's position in its table, staring with zero from left to right.- Returns:
- the column index
- Since:
- 4.0.0
-