ExportRules (poi-excel 3.2.0 API)

java.lang.Object
- com.github.stupdit1t.excel.core.export.ExportRules

```
public class ExportRules
extends Object
```

字段概要

字段
限定符和类型	字段和说明
`private boolean`	`autoNum` 是否带序号
`private int`	`autoNumColumnWidth` 自动排序列宽度
`private short`	`cellHeight` 单元格高度
`private List<OutColumn<?>>`	`column` 列数据规则定义
`private int`	`columnWidth` 列宽度
`private List<ComplexCell>`	`complexHeader` excel头：合并规则及值，rules.put("1,1,A,G", "其它应扣"); 对应excel位置
`private short`	`footerHeight` 尾部高度
`private List<ComplexCell>`	`footerRules` excel尾：合并规则及值，rules.put("1,1,A,G", 值); 对应excel位置
`private boolean`	`freezeHeader` 是否冻结表头
`private ICellStyle[]`	`globalStyle` 全局单元格样式
`private short`	`headerHeight` 表头高度
`private boolean`	`ifFooter` 是否有页脚
`private boolean`	`ifMerge` 是否合并表头
`private int`	`maxColumns` 最大单元格列数
`private int`	`maxRows` 表头最大行数
`private List<Integer[]>`	`mergerCells` 自定义合并的单元格
`private String`	`password` Excel密码, 只支持xls 格式
`private String`	`sheetName` sheetName
`private boolean`	`simple` 是否简单导出
`private LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>>`	`simpleHeader` 标题列
`private String`	`title` 表头名
`private short`	`titleHeight` 标题高度
`private boolean`	`xlsx` 是否导出xlsx

构造器概要

构造器
限定符	构造器和说明
`private`	`ExportRules(List<OutColumn<?>> column, LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> header, boolean simple)` 常规一行表头构造,不带尾部
`private`	`ExportRules(List<OutColumn<?>> column, List<ComplexCell> complexHeader)` 复杂表头构造

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static ExportRules`	`complexRule(List<OutColumn<?>> column, List<ComplexCell> complexHeader)` 初始化规则，构建一个复杂表头
`int`	`getAutoNumColumnWidth()` 自动学号列宽度
`short`	`getCellHeight()` 单元格高度
`List<OutColumn<?>>`	`getColumn()` 获取输出列
`int`	`getColumnWidth()` 获取全局列宽
`List<ComplexCell>`	`getComplexHeader()` 获取复杂表头设计
`short`	`getFooterHeight()` 尾行高度
`List<ComplexCell>`	`getFooterRules()` 获取复杂尾部设计
`ICellStyle[]`	`getGlobalStyle()` 全局样式
`short`	`getHeaderHeight()` 表头高度
`int`	`getMaxColumns()` 获取最大列
`int`	`getMaxRows()` 获取最大行
`List<Integer[]>`	`getMergerCells()` 自定义合并单元格
`String`	`getPassword()` 获取book密码
`String`	`getSheetName()` 获取sheet名字
`LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>>`	`getSimpleHeader()` 获取简单表头设置
`String`	`getTitle()` 获取大标题
`short`	`getTitleHeight()` 大标题高度
`boolean`	`isAutoNum()` 是否自动生成序号
`boolean`	`isFreezeHeader()` 是否冻结表头
`boolean`	`isIfFooter()` 是否有尾行
`boolean`	`isIfMerge()` 是否合并模式
`boolean`	`isSimple()` 是否简单导出
`boolean`	`isXlsx()` 是否xlsx格式
`void`	`setAutoNum(boolean autoNum)` 自动生成序号 complexRule：需要自定义手动定义表头 simpleRule：自动生成表头序号
`void`	`setAutoNumColumnWidth(int autoNumColumnWidth)` 序号列宽度
`void`	`setCellHeight(short cellHeight)` 单元格高度
`void`	`setColumnWidth(int columnWidth)` 全部列宽度
`private void`	`setComplexHeader(List<ComplexCell> complexHeader)` 设置复杂表头
`void`	`setFooterHeight(short footerHeight)` 尾行高度
`void`	`setFooterRules(List<ComplexCell> footerRules)` 尾行设计
`void`	`setFreezeHeader(boolean freezeHeader)` 是否冻结表头
`void`	`setGlobalStyle(ICellStyle... globalStyle)` 设置全局样式
`void`	`setHeaderHeight(short headerHeight)` 表头高度
`void`	`setMergerCells(List<Integer[]> mergerCells)` 设置合并单元格
`void`	`setPassword(String password)` 设置excel密码
`void`	`setSheetName(String sheetName)` 设置sheet名字
`private void`	`setSimpleHeader(LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> simpleHeader)` 设置简单表头
`void`	`setTitle(String title)` 大标题设置
`void`	`setTitleHeight(short titleHeight)` 大标题高度
`void`	`setXlsx(boolean xlsx)` 是否导出07 xlsx
`static ExportRules`	`simpleRule(List<OutColumn<?>> column, LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> header)` 初始化规则，构建一个简单表头
`void`	`title(String title)` 表头设置

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

字段详细资料

sheetName
```
private String sheetName
```
sheetName

autoNum
```
private boolean autoNum
```
是否带序号

column

private final List<OutColumn<?>> column

列数据规则定义

title
```
private String title
```
表头名

simpleHeader

private LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> simpleHeader

标题列

complexHeader
```
private List<ComplexCell> complexHeader
```
excel头：合并规则及值，rules.put("1,1,A,G", "其它应扣"); 对应excel位置

footerRules
```
private List<ComplexCell> footerRules
```
excel尾：合并规则及值，rules.put("1,1,A,G", 值); 对应excel位置

maxColumns
```
private int maxColumns
```
最大单元格列数

maxRows
```
private int maxRows
```
表头最大行数

ifMerge
```
private boolean ifMerge
```
是否合并表头

ifFooter
```
private boolean ifFooter
```
是否有页脚

simple
```
private boolean simple
```
是否简单导出

xlsx
```
private boolean xlsx
```
是否导出xlsx

globalStyle
```
private ICellStyle[] globalStyle
```
全局单元格样式

password
```
private String password
```
Excel密码, 只支持xls 格式

freezeHeader
```
private boolean freezeHeader
```
是否冻结表头

titleHeight
```
private short titleHeight
```
标题高度

headerHeight
```
private short headerHeight
```
表头高度

cellHeight
```
private short cellHeight
```
单元格高度

footerHeight
```
private short footerHeight
```
尾部高度

autoNumColumnWidth
```
private int autoNumColumnWidth
```
自动排序列宽度

columnWidth
```
private int columnWidth
```
列宽度

mergerCells
```
private List<Integer[]> mergerCells
```
自定义合并的单元格

构造器详细资料

ExportRules

private ExportRules(List<OutColumn<?>> column,
                    LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> header,
                    boolean simple)

常规一行表头构造,不带尾部

参数:: column - 列数据规则定义; header - 表头标题; simple - 简单表头

ExportRules

private ExportRules(List<OutColumn<?>> column,
                    List<ComplexCell> complexHeader)

复杂表头构造

参数:: column - 列数据规则定义; complexHeader - 表头设计

方法详细资料
- simpleRule
```
public static ExportRules simpleRule(List<OutColumn<?>> column,
                                     LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> header)
```
  初始化规则，构建一个简单表头
  
  参数:
  
  column - 定义导出列字段
  
  header - 表头设计
- complexRule
```
public static ExportRules complexRule(List<OutColumn<?>> column,
                                      List<ComplexCell> complexHeader)
```
  初始化规则，构建一个复杂表头
  
  参数:
  
  column - 定义导出列字段
  
  complexHeader - 表头设计
- setSimpleHeader
```
private void setSimpleHeader(LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> simpleHeader)
```
  设置简单表头
  
  参数:
  
  simpleHeader - 简单表头设置
- setComplexHeader
```
private void setComplexHeader(List<ComplexCell> complexHeader)
```
  设置复杂表头
  
  参数:
  
  complexHeader - 复杂表土设置
- setFooterRules
```
public void setFooterRules(List<ComplexCell> footerRules)
```
  尾行设计
  
  参数:
  
  footerRules - 尾部合计行设计
- setAutoNum
```
public void setAutoNum(boolean autoNum)
```
  自动生成序号 complexRule：需要自定义手动定义表头 simpleRule：自动生成表头序号
  
  参数:
  
  autoNum - 自动生成序号
- title
```
public void title(String title)
```
  表头设置
  
  参数:
  
  title - 表头标题
- getPassword
```
public String getPassword()
```
  获取book密码
  
  返回:
  
  String
- isXlsx
```
public boolean isXlsx()
```
  是否xlsx格式
  
  返回:
  
  boolean
- getGlobalStyle
```
public ICellStyle[] getGlobalStyle()
```
  全局样式
  
  返回:
  
  ICellStyle[]
- getSheetName
```
public String getSheetName()
```
  获取sheet名字
  
  返回:
  
  String
- isAutoNum
```
public boolean isAutoNum()
```
  是否自动生成序号
  
  返回:
  
  boolean
- getColumn
```
public List<OutColumn<?>> getColumn()
```
  获取输出列
  
  返回:
  
  List>
- getTitle
```
public String getTitle()
```
  获取大标题
  
  返回:
  
  List>
- getSimpleHeader
```
public LinkedHashMap<String,java.util.function.BiConsumer<org.apache.poi.ss.usermodel.Font,org.apache.poi.ss.usermodel.CellStyle>> getSimpleHeader()
```
  获取简单表头设置
  
  返回:
  
  LinkedHashMap>
- getComplexHeader
```
public List<ComplexCell> getComplexHeader()
```
  获取复杂表头设计
  
  返回:
  
  List
- getFooterRules
```
public List<ComplexCell> getFooterRules()
```
  获取复杂尾部设计
  
  返回:
  
  List
- getMaxColumns
```
public int getMaxColumns()
```
  获取最大列
  
  返回:
  
  int
- getMaxRows
```
public int getMaxRows()
```
  获取最大行
  
  返回:
  
  int
- isIfMerge
```
public boolean isIfMerge()
```
  是否合并模式
  
  返回:
  
  boolean
- isIfFooter
```
public boolean isIfFooter()
```
  是否有尾行
  
  返回:
  
  boolean
- isSimple
```
public boolean isSimple()
```
  是否简单导出
  
  返回:
  
  boolean
- isFreezeHeader
```
public boolean isFreezeHeader()
```
  是否冻结表头
  
  返回:
  
  boolean
- getTitleHeight
```
public short getTitleHeight()
```
  大标题高度
  
  返回:
  
  short
- getHeaderHeight
```
public short getHeaderHeight()
```
  表头高度
  
  返回:
  
  short
- getCellHeight
```
public short getCellHeight()
```
  单元格高度
  
  返回:
  
  short
- getFooterHeight
```
public short getFooterHeight()
```
  尾行高度
  
  返回:
  
  short
- getAutoNumColumnWidth
```
public int getAutoNumColumnWidth()
```
  自动学号列宽度
  
  返回:
  
  int
- getMergerCells
```
public List<Integer[]> getMergerCells()
```
  自定义合并单元格
  
  返回:
  
  List
- setSheetName
```
public void setSheetName(String sheetName)
```
  设置sheet名字
  
  参数:
  
  sheetName - sheet名字
- setTitle
```
public void setTitle(String title)
```
  大标题设置
  
  参数:
  
  title - 标题
- setXlsx
```
public void setXlsx(boolean xlsx)
```
  是否导出07 xlsx
  
  参数:
  
  xlsx - true or false
- setGlobalStyle
```
public void setGlobalStyle(ICellStyle... globalStyle)
```
  设置全局样式
  
  参数:
  
  globalStyle - 样式
- setPassword
```
public void setPassword(String password)
```
  设置excel密码
  
  参数:
  
  password - 密码
- setFreezeHeader
```
public void setFreezeHeader(boolean freezeHeader)
```
  是否冻结表头
  
  参数:
  
  freezeHeader - 冻结
- setTitleHeight
```
public void setTitleHeight(short titleHeight)
```
  大标题高度
  
  参数:
  
  titleHeight - 高度
- setHeaderHeight
```
public void setHeaderHeight(short headerHeight)
```
  表头高度
  
  参数:
  
  headerHeight - 高度
- setCellHeight
```
public void setCellHeight(short cellHeight)
```
  单元格高度
  
  参数:
  
  cellHeight - 高度
- setFooterHeight
```
public void setFooterHeight(short footerHeight)
```
  尾行高度
  
  参数:
  
  footerHeight - 高度
- setAutoNumColumnWidth
```
public void setAutoNumColumnWidth(int autoNumColumnWidth)
```
  序号列宽度
  
  参数:
  
  autoNumColumnWidth - 宽度
- setColumnWidth
```
public void setColumnWidth(int columnWidth)
```
  全部列宽度
  
  参数:
  
  columnWidth - 宽度
- setMergerCells
```
public void setMergerCells(List<Integer[]> mergerCells)
```
  设置合并单元格
  
  参数:
  
  mergerCells - 合并单元格
- getColumnWidth
```
public int getColumnWidth()
```
  获取全局列宽

类 ExportRules

字段概要

构造器概要

方法概要

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

字段详细资料

sheetName

autoNum

column

title

simpleHeader

complexHeader

footerRules

maxColumns

maxRows

ifMerge

ifFooter

simple

xlsx

globalStyle

password

freezeHeader

titleHeight

headerHeight

cellHeight

footerHeight

autoNumColumnWidth

columnWidth

mergerCells

构造器详细资料

ExportRules

ExportRules

方法详细资料

simpleRule

complexRule

setSimpleHeader

setComplexHeader

setFooterRules

setAutoNum

title

getPassword

isXlsx

getGlobalStyle

getSheetName

isAutoNum

getColumn

getTitle

getSimpleHeader

getComplexHeader

getFooterRules

getMaxColumns

getMaxRows

isIfMerge

isIfFooter

isSimple

isFreezeHeader

getTitleHeight

getHeaderHeight

getCellHeight

getFooterHeight

getAutoNumColumnWidth

getMergerCells

setSheetName

setTitle

setXlsx

setGlobalStyle

setPassword

setFreezeHeader

setTitleHeight

setHeaderHeight

setCellHeight

setFooterHeight

setAutoNumColumnWidth

setColumnWidth

setMergerCells

getColumnWidth