Column (Excel Write/Read Framework 0.5.4 API)

java.lang.Object
- org.ttzero.excel.entity.Column

直接已知子类:

ListSheet.EntryColumn, Sheet.Column
```
public class Column
extends Object
```
Associated with Worksheet for controlling head style and cache column data types and conversions

作者:

guanquan.wang at 2021-08-29 19:49

字段概要

字段
限定符和类型	字段和说明
`Comment`	`cellComment`
`Integer`	`cellStyle` The style of cell
`Class<?>`	`clazz` The cell type
`int`	`colIndex` Specify the column index
`Comment`	`headerComment`
`Integer`	`headerStyle` The style of header
`boolean`	`hide` Hidden current column Only set the column to hide, the data will still be written, you can right-click to "un-hide" to display in file
`boolean`	`ignoreValue` Only export column name and ignore value
`String`	`key` The key of Map or field name of entry
`String`	`name` The header name
`Column`	`next` The next Column point Support multi header columns
`NumFmt`	`numFmt` Specify the cell number format
`double`	`o`
`Column`	`prev` The previous Column point Support multi header columns
`ConversionProcessor`	`processor` The int value conversion
`int`	`realColIndex` The real col-Index used to write
`boolean`	`share` The string value is shared
`StyleProcessor`	`styleProcessor` The style conversion
`Styles`	`styles`
`Column`	`tail` The tail Column point Support multi header columns
`double`	`width` The cell width
`int`	`wrapText` Wrap text in a cell

构造器概要

构造器
构造器和说明
`Column()` Constructor Column
`Column(String name)` Constructor Column
`Column(String name, Class<?> clazz)` Constructor Column
`Column(String name, Class<?> clazz, boolean share)` Constructor Column
`Column(String name, Class<?> clazz, ConversionProcessor processor)` Constructor Column
`Column(String name, Class<?> clazz, ConversionProcessor processor, boolean share)` Constructor Column
`Column(String name, Class<?> clazz, int cellStyle)` Constructor Column
`Column(String name, Class<?> clazz, int cellStyle, boolean share)` Constructor Column
`Column(String name, String key)` Constructor Column
`Column(String name, String key, boolean share)` Constructor Column
`Column(String name, String key, Class<?> clazz)` Constructor Column
`Column(String name, String key, Class<?> clazz, ConversionProcessor processor)` Constructor Column
`Column(String name, String key, ConversionProcessor processor)` Constructor Column
`Column(String name, String key, ConversionProcessor processor, boolean share)` Constructor Column
`Column(String name, String key, int cellStyle)` Constructor Column
`Column(String name, String key, int cellStyle, boolean share)` Constructor Column

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Column`	`addSubColumn(Column column)` Append sub-column at the tail
`int`	`getCellStyle()` Setting the cell styles
`int`	`getCellStyle(Class<?> clazz)` Returns default style based on cell type
`int`	`getCellStyleIndex()` Returns the style index of cell, -1 if not be setting
`Class<?>`	`getClazz()` Returns the cell type
`int`	`getHeaderStyleIndex()` Returns the header style index of cell, -1 if not be setting
`String`	`getName()` Returns the column name
`NumFmt`	`getNumFmt()` Returns the column `NumFmt`
`int`	`getRealColIndex()` Returns the real col-index(one base)
`double`	`getWidth()` Returns the width of cell
`Column`	`hide()` Hidden current column
`Column`	`ignoreValue()` Ignore value
`boolean`	`isHide()` Returns hide flag
`boolean`	`isIgnoreValue()`
`boolean`	`isShare()` Setting the cell is shared
`Column`	`setCellStyle(Font font)` Setting the cell styles
`Column`	`setCellStyle(Font font, Border border)` Setting the cell styles
`Column`	`setCellStyle(Font font, Border border, int horizontal)` Setting the cell styles
`Column`	`setCellStyle(Font font, Fill fill, Border border)` Setting the cell styles
`Column`	`setCellStyle(Font font, Fill fill, Border border, int horizontal)` Setting the cell styles
`Column`	`setCellStyle(Font font, Fill fill, Border border, int vertical, int horizontal)` Setting the cell styles
`Column`	`setCellStyle(Font font, int horizontal)` Setting the cell styles
`Column`	`setCellStyle(int cellStyle)` Setting the cell's style
`Column`	`setCellStyle(NumFmt numFmt, Font font, Fill fill, Border border, int vertical, int horizontal)` Setting the cell styles
`Column`	`setClazz(Class<?> clazz)` Setting the cell type
`Column`	`setColIndex(int colIndex)` Settings the x-axis of column in row
`Column`	`setHeaderComment(Comment headerComment)` Setting the header cell comment
`Column`	`setHeaderStyle(int headerStyle)` Setting the header's style
`Column`	`setName(String name)` Setting the column name
`Column`	`setNumFmt(NumFmt numFmt)` Setting a cell format of number or date type
`Column`	`setNumFmt(String code)` Setting a cell format of number or date type
`Column`	`setProcessor(ConversionProcessor processor)` Setting the int value conversion
`Column`	`setShare(boolean share)` Setting cell string value is shared Shared is only valid for strings, and the converted cell type is also valid for strings.
`Column`	`setStyleProcessor(StyleProcessor styleProcessor)` Setting the style conversion
`Column`	`setWidth(double width)` Setting the cell's width
`Column`	`setWrapText(boolean wrapText)` Wrap text in a cell Microsoft Excel can wrap text so it appears on multiple lines in a cell.
`Column`	`show()` Show current column
`int`	`subColumnSize()` Returns the size of sub-column
`Column[]`	`toArray()` Returns an array containing all of the sub-column
`Column[]`	`toArray(Column[] dist)` Returns an array containing all of the sub-column
`Column`	`trimTail()` Trim tail nodes after write

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - key
```
public String key
```
    The key of Map or field name of entry
  - name
```
public String name
```
    The header name
  - clazz
```
public Class<?> clazz
```
    The cell type
  - share
```
public boolean share
```
    The string value is shared
  - processor
```
public ConversionProcessor processor
```
    The int value conversion
  - styleProcessor
```
public StyleProcessor styleProcessor
```
    The style conversion
  - cellStyle
```
public Integer cellStyle
```
    The style of cell
  - headerStyle
```
public Integer headerStyle
```
    The style of header
  - width
```
public double width
```
    The cell width
  - o
```
public double o
```
  - styles
```
public Styles styles
```
  - headerComment
```
public Comment headerComment
```
  - cellComment
```
public Comment cellComment
```
  - numFmt
```
public NumFmt numFmt
```
    Specify the cell number format
  - ignoreValue
```
public boolean ignoreValue
```
    Only export column name and ignore value
  - wrapText
```
public int wrapText
```
    Wrap text in a cell
  - colIndex
```
public int colIndex
```
    Specify the column index
  - prev
```
public Column prev
```
    The previous Column point Support multi header columns
    
    从以下版本开始:
    
    0.5.1
  - next
```
public Column next
```
    The next Column point Support multi header columns
    
    从以下版本开始:
    
    0.5.1
  - tail
```
public Column tail
```
    The tail Column point Support multi header columns
    
    从以下版本开始:
    
    0.5.1
  - realColIndex
```
public int realColIndex
```
    The real col-Index used to write
  - hide
```
public boolean hide
```
    Hidden current column
    Only set the column to hide, the data will still be written, you can right-click to "un-hide" to display in file
- 构造器详细资料
  - Column
```
public Column()
```
    Constructor Column
  - Column
```
public Column(String name)
```
    Constructor Column
    
    参数:
    
    name - the column name
  - Column
```
public Column(String name,
              Class<?> clazz)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    clazz - the cell type
  - Column
```
public Column(String name,
              String key)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - field
  - Column
```
public Column(String name,
              String key,
              Class<?> clazz)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - field
    
    clazz - the cell type
  - Column
```
public Column(String name,
              Class<?> clazz,
              ConversionProcessor processor)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    clazz - the cell type
    
    processor - The int value conversion
  - Column
```
public Column(String name,
              String key,
              ConversionProcessor processor)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - field
    
    processor - The int value conversion
  - Column
```
public Column(String name,
              Class<?> clazz,
              boolean share)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    clazz - the cell type
    
    share - true:shared false:inline string
  - Column
```
public Column(String name,
              String key,
              boolean share)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - filed
    
    share - true:shared false:inline string
  - Column
```
public Column(String name,
              Class<?> clazz,
              ConversionProcessor processor,
              boolean share)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    clazz - the cell type
    
    processor - The int value conversion
    
    share - true:shared false:inline string
  - Column
```
public Column(String name,
              String key,
              Class<?> clazz,
              ConversionProcessor processor)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - field
    
    clazz - type of cell
    
    processor - The int value conversion
  - Column
```
public Column(String name,
              String key,
              ConversionProcessor processor,
              boolean share)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - field
    
    processor - The int value conversion
    
    share - true:shared false:inline string
  - Column
```
public Column(String name,
              Class<?> clazz,
              int cellStyle)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    clazz - the cell type
    
    cellStyle - the style of cell
  - Column
```
public Column(String name,
              String key,
              int cellStyle)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - field
    
    cellStyle - the style of cell
  - Column
```
public Column(String name,
              Class<?> clazz,
              int cellStyle,
              boolean share)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    clazz - the cell type
    
    cellStyle - the style of cell
    
    share - true:shared false:inline string
  - Column
```
public Column(String name,
              String key,
              int cellStyle,
              boolean share)
```
    Constructor Column
    
    参数:
    
    name - the column name
    
    key - field
    
    cellStyle - the style of cell
    
    share - true:shared false:inline string
- 方法详细资料
  - setWidth
```
public Column setWidth(double width)
```
    Setting the cell's width
    
    参数:
    
    width - the width value
    
    返回:
    
    the Column
  - isShare
```
public boolean isShare()
```
    Setting the cell is shared
    
    返回:
    
    true:shared false:inline string
  - getName
```
public String getName()
```
    Returns the column name
    
    返回:
    
    the column name
  - setName
```
public Column setName(String name)
```
    Setting the column name
    
    参数:
    
    name - the column name
    
    返回:
    
    the Column
  - getClazz
```
public Class<?> getClazz()
```
    Returns the cell type
    
    返回:
    
    the cell type
  - setClazz
```
public Column setClazz(Class<?> clazz)
```
    Setting the cell type
    
    参数:
    
    clazz - the cell type
    
    返回:
    
    the Column
  - setProcessor
```
public Column setProcessor(ConversionProcessor processor)
```
    Setting the int value conversion
    
    参数:
    
    processor - The int value conversion
    
    返回:
    
    the Column
  - setStyleProcessor
```
public Column setStyleProcessor(StyleProcessor styleProcessor)
```
    Setting the style conversion
    
    参数:
    
    styleProcessor - The style conversion
    
    返回:
    
    the Column
  - getWidth
```
public double getWidth()
```
    Returns the width of cell
    
    返回:
    
    the cell width
  - setCellStyle
```
public Column setCellStyle(int cellStyle)
```
    Setting the cell's style
    
    参数:
    
    cellStyle - the styles value
    
    返回:
    
    the Column
  - setHeaderStyle
```
public Column setHeaderStyle(int headerStyle)
```
    Setting the header's style
    
    参数:
    
    headerStyle - the styles value
    
    返回:
    
    the Column
  - setColIndex
```
public Column setColIndex(int colIndex)
```
    Settings the x-axis of column in row
    
    参数:
    
    colIndex - column index (zero base)
    
    返回:
    
    the Column
  - getCellStyleIndex
```
public int getCellStyleIndex()
```
    Returns the style index of cell, -1 if not be setting
    
    返回:
    
    index of style
  - getHeaderStyleIndex
```
public int getHeaderStyleIndex()
```
    Returns the header style index of cell, -1 if not be setting
    
    返回:
    
    index of style
  - setCellStyle
```
public Column setCellStyle(Font font)
```
    Setting the cell styles
    
    参数:
    
    font - the font
    
    返回:
    
    the Column
  - setCellStyle
```
public Column setCellStyle(Font font,
                           int horizontal)
```
    Setting the cell styles
    
    参数:
    
    font - the font
    
    horizontal - the horizontal style
    
    返回:
    
    the Column
  - setCellStyle
```
public Column setCellStyle(Font font,
                           Border border)
```
    Setting the cell styles
    
    参数:
    
    font - the font
    
    border - the border style
    
    返回:
    
    the Column
  - setCellStyle
```
public Column setCellStyle(Font font,
                           Border border,
                           int horizontal)
```
    Setting the cell styles
    
    参数:
    
    font - the font
    
    border - the border style
    
    horizontal - the horizontal style
    
    返回:
    
    the Column
  - setCellStyle
```
public Column setCellStyle(Font font,
                           Fill fill,
                           Border border)
```
    Setting the cell styles
    
    参数:
    
    font - the font
    
    fill - the fill style
    
    border - the border style
    
    返回:
    
    the Column
  - setCellStyle
```
public Column setCellStyle(Font font,
                           Fill fill,
                           Border border,
                           int horizontal)
```
    Setting the cell styles
    
    参数:
    
    font - the font
    
    fill - the fill style
    
    border - the border style
    
    horizontal - the horizontal style
    
    返回:
    
    the Column
  - setCellStyle
```
public Column setCellStyle(Font font,
                           Fill fill,
                           Border border,
                           int vertical,
                           int horizontal)
```
    Setting the cell styles
    
    参数:
    
    font - the font
    
    fill - the fill style
    
    border - the border style
    
    vertical - the vertical style
    
    horizontal - the horizontal style
    
    返回:
    
    the Column
  - setCellStyle
```
public Column setCellStyle(NumFmt numFmt,
                           Font font,
                           Fill fill,
                           Border border,
                           int vertical,
                           int horizontal)
```
    Setting the cell styles
    
    参数:
    
    numFmt - the number format
    
    font - the font
    
    fill - the fill style
    
    border - the border style
    
    vertical - the vertical style
    
    horizontal - the horizontal style
    
    返回:
    
    the Column
  - setShare
```
public Column setShare(boolean share)
```
    Setting cell string value is shared Shared is only valid for strings, and the converted cell type is also valid for strings.
    
    参数:
    
    share - true:shared false:inline string
    
    返回:
    
    the Column
  - setNumFmt
```
public Column setNumFmt(String code)
```
    Setting a cell format of number or date type
    
    参数:
    
    code - the format string
    
    返回:
    
    the Column
  - setNumFmt
```
public Column setNumFmt(NumFmt numFmt)
```
    Setting a cell format of number or date type
    
    参数:
    
    numFmt - NumFmt
    
    返回:
    
    the Column
  - getNumFmt
```
public NumFmt getNumFmt()
```
    Returns the column NumFmt
    
    返回:
    
    number format
  - getCellStyle
```
public int getCellStyle(Class<?> clazz)
```
    Returns default style based on cell type
    
    参数:
    
    clazz - the cell type
    
    返回:
    
    the styles value
  - getCellStyle
```
public int getCellStyle()
```
    Setting the cell styles
    
    返回:
    
    the styles value
  - isIgnoreValue
```
public boolean isIgnoreValue()
```
    返回:
    
    bool
  - ignoreValue
```
public Column ignoreValue()
```
    Ignore value
    
    返回:
    
    the Column self
  - setWrapText
```
public Column setWrapText(boolean wrapText)
```
    Wrap text in a cell
    Microsoft Excel can wrap text so it appears on multiple lines in a cell. You can format the cell so the text wraps automatically, or enter a manual line break.
    
    参数:
    
    wrapText - set wrap
    
    返回:
    
    the Column self
  - setHeaderComment
```
public Column setHeaderComment(Comment headerComment)
```
    Setting the header cell comment
    
    参数:
    
    headerComment - Comment
    
    返回:
    
    the Column self
  - addSubColumn
```
public Column addSubColumn(Column column)
```
    Append sub-column at the tail
    
    参数:
    
    column - a sub-column
    
    返回:
    
    the Column self
  - subColumnSize
```
public int subColumnSize()
```
    Returns the size of sub-column
    
    返回:
    
    size of sub-column(include root column)
  - toArray
```
public Column[] toArray()
```
    Returns an array containing all of the sub-column
    
    返回:
    
    an array containing all of the Column
  - toArray
```
public Column[] toArray(Column[] dist)
```
    Returns an array containing all of the sub-column
    
    参数:
    
    dist - the array into which the elements of the column are to be stored
    
    返回:
    
    header columns
    
    抛出:
    
    NullPointerException - if the specified array is null
  - getRealColIndex
```
public int getRealColIndex()
```
    Returns the real col-index(one base)
    
    返回:
    
    real col-index(one base)
  - trimTail
```
public Column trimTail()
```
    Trim tail nodes after write
    
    返回:
    
    current
  - isHide
```
public boolean isHide()
```
    Returns hide flag
    
    返回:
    
    true: hidden otherwise show
  - hide
```
public Column hide()
```
    Hidden current column
    
    返回:
    
    current Column
  - show
```
public Column show()
```
    Show current column
    
    返回:
    
    current Column

类 Column

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

key

name

clazz

share

processor

styleProcessor

cellStyle

headerStyle

width

o

styles

headerComment

cellComment

numFmt

ignoreValue

wrapText

colIndex

prev

next

tail

realColIndex

hide

构造器详细资料

Column

Column

Column

Column

Column

Column

Column

Column

Column

Column

Column

Column

Column

Column

Column

Column

方法详细资料

setWidth

isShare

getName

setName

getClazz

setClazz

setProcessor

setStyleProcessor

getWidth

setCellStyle

setHeaderStyle

setColIndex

getCellStyleIndex

getHeaderStyleIndex

setCellStyle

setCellStyle

setCellStyle

setCellStyle

setCellStyle

setCellStyle

setCellStyle

setCellStyle

setShare

setNumFmt

setNumFmt

getNumFmt

getCellStyle

getCellStyle

isIgnoreValue

ignoreValue

setWrapText

setHeaderComment

addSubColumn

subColumnSize