Class ColumnHelper
java.lang.Object
org.apache.poi.xssf.usermodel.helpers.ColumnHelper
Helper class for dealing with the Column settings on
a CTWorksheet (the data part of a sheet).
Note - within POI, we use 0 based column indexes, but
the column definitions in the XML are 1 based!
-
Constructor Summary
ConstructorsConstructorDescriptionColumnHelper(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet) -
Method Summary
Modifier and TypeMethodDescriptionorg.openxmlformats.schemas.spreadsheetml.x2006.main.CTColsaddCleanColIntoCols(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol newCol) voidorg.openxmlformats.schemas.spreadsheetml.x2006.main.CTColcloneCol(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol col) booleancolumnExists(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, long index) Does the column at the given 0 based index exist in the supplied list of column definitions?intgetColDefaultStyle(long index) org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColgetColumn(long index, boolean splitColumns) Returns the Column at the given 0 based indexorg.openxmlformats.schemas.spreadsheetml.x2006.main.CTColgetColumn1Based(long index1, boolean splitColumns) Returns the Column at the given 1 based index.intgetIndexOfColumn(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol searchCol) protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColgetOrCreateColumn1Based(long index1, boolean splitColumns) Return the CTCol at the given (0 based) column index, creating it if required.voidsetColBestFit(long index, boolean bestFit) voidsetColDefaultStyle(long index, int styleId) voidsetColDefaultStyle(long index, CellStyle style) voidsetColHidden(long index, boolean hidden) voidsetColumnAttributes(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol fromCol, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol toCol) voidsetColWidth(long index, double width) voidsetCustomWidth(long index, boolean bestFit) static voidsortColumns(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols newCols)
-
Constructor Details
-
ColumnHelper
public ColumnHelper(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet)
-
-
Method Details
-
cleanColumns
public void cleanColumns() -
addCleanColIntoCols
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols addCleanColIntoCols(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol newCol) -
sortColumns
public static void sortColumns(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols newCols) -
cloneCol
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol cloneCol(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol col) -
getColumn
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol getColumn(long index, boolean splitColumns) Returns the Column at the given 0 based index -
getColumn1Based
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol getColumn1Based(long index1, boolean splitColumns) Returns the Column at the given 1 based index. POI default is 0 based, but the file stores as 1 based. -
columnExists
public boolean columnExists(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, long index) Does the column at the given 0 based index exist in the supplied list of column definitions? -
setColumnAttributes
public void setColumnAttributes(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol fromCol, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol toCol) -
setColBestFit
public void setColBestFit(long index, boolean bestFit) -
setCustomWidth
public void setCustomWidth(long index, boolean bestFit) -
setColWidth
public void setColWidth(long index, double width) -
setColHidden
public void setColHidden(long index, boolean hidden) -
getOrCreateColumn1Based
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol getOrCreateColumn1Based(long index1, boolean splitColumns) Return the CTCol at the given (0 based) column index, creating it if required. -
setColDefaultStyle
-
setColDefaultStyle
public void setColDefaultStyle(long index, int styleId) -
getColDefaultStyle
public int getColDefaultStyle(long index) -
getIndexOfColumn
public int getIndexOfColumn(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCols cols, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCol searchCol)
-