Package org.apache.poi.xssf.usermodel
Class XSSFTableColumn
- java.lang.Object
-
- org.apache.poi.xssf.usermodel.XSSFTableColumn
-
public class XSSFTableColumn extends java.lang.ObjectA table column of anXSSFTable. UseXSSFTable.createColumn(java.lang.String)to create new table columns.- Since:
- 4.0.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetColumnIndex()Get the column's position in its table, staring with zero from left to right.longgetId()Get the identifier of this column, which is is unique per table.java.lang.StringgetName()Get the name of the column, which is is unique per table.XSSFTablegetTable()Get the table which contains this columnXSSFXmlColumnPrgetXmlColumnPr()Get the XmlColumnPr (XML column properties) if this column has an XML mapping.voidsetId(long columnId)Set the identifier of this column, which must be unique per table.voidsetName(java.lang.String columnName)Get the name of the column, which is is unique per table.
-
-
-
Method Detail
-
getTable
public XSSFTable 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
public java.lang.String getName()
Get the name of the column, which is is unique per table.- Returns:
- the column name
- Since:
- 4.0.0
-
setName
public void setName(java.lang.String columnName)
Get the name of the column, which is is unique per table.- Since:
- 4.0.0
-
getXmlColumnPr
public XSSFXmlColumnPr getXmlColumnPr()
Get the XmlColumnPr (XML column properties) if this column has an XML mapping.- Returns:
- the XmlColumnPr or
nullif 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
-
-