jexx.poi.header

类 Headers

java.lang.Object

jexx.poi.header.Headers

public class Headers
extends java.lang.Object

header set, it's useful to manager header

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_HEADERS
protected boolean	flushed 添加header后是否调用过flush
protected HeaderRowContext	headerRowContext
static java.lang.String	INDEX_TAG
protected java.util.Map<IHeader,java.util.List<RowTrigger>>	rowTriggerMap

构造器概要

构造器

构造器和说明
Headers()
Headers(int startHeaderNum)
Headers(int startHeaderNum, java.lang.String name) 构造
Headers(java.lang.String name)

方法概要

限定符和类型	方法和说明
IDataHeader	addArrayHeader(java.lang.String label, java.lang.String value, ArrayMeta meta)
IDataHeader	addArrayHeader(java.lang.String label, java.lang.String value, ArrayMeta meta, IWrapCellStyle headerCellStyle, IWrapCellStyle dataCellStyle) 添加array头信息
ICustomHeader	addHeader(ICustomHeader header) 添加自定义header
IDataHeader	addHeader(IDataHeader header) 添加数据header
IGroupHeader	addHeader(IGroupHeader header) 添加分组header
IDataHeader	addHeader(java.lang.String label, java.lang.String value)
IDataHeader	addHeader(java.lang.String label, java.lang.String value, IWrapCellStyle headerCellStyle, IWrapCellStyle dataCellStyle) 添加默认头
void	addHeaders(java.util.Map<java.lang.String,java.lang.String> headerAlias)
void	addRowTrigger(IDataHeader header, RowTrigger trigger)
void	addRowTrigger(java.lang.String headerName, RowTrigger trigger)
ICustomHeader	addSequenceHeader(java.lang.String value) 添加序列header
ICustomHeader	addSequenceHeader(java.lang.String value, IDataHeader sameLevelHeader)
IDataHeader	addTreeHeader(java.lang.String label, java.lang.String value, TreeMeta meta)
IDataHeader	addTreeHeader(java.lang.String label, java.lang.String value, TreeMeta meta, IDataHeader referHeader)
IDataHeader	addTreeHeader(java.lang.String label, java.lang.String value, TreeMeta meta, IDataHeader referHeader, IWrapCellStyle headerCellStyle, IWrapCellStyle dataCellStyle) 添加tree头信息
IDataHeader	addTreeHeader(java.lang.String label, java.lang.String value, TreeMeta meta, IWrapCellStyle headerCellStyle, IWrapCellStyle dataCellStyle) 添加第一层header信息
IDataHeader	addTreeHeader(java.lang.String label, java.lang.String value, TreeMeta meta, java.lang.String referHeaderName)
IDataHeader	addTreeHeader(java.lang.String label, java.lang.String value, TreeMeta meta, java.lang.String referHeaderName, IWrapCellStyle headerCellStyle, IWrapCellStyle dataCellStyle) 添加tree头信息
java.util.List<IMergedCell>	createHeaderCells(int startRowNum) create cells of the header
void	flush() 刷新headers 刷新header引用: 一些header在引用其他header时,使用的是名字引用，而非对象; 因此需要帮助重新设置对象,确保对象存在
java.util.List<ICustomHeader>	getCustomHeaders() 获取自定义header
IDataHeader	getDataHeaderByColumnNum(int columnNum) get data-header by column num
IDataHeader	getDataHeaderByLabel(java.lang.String label) get data header by label
java.util.List<IDataHeader>	getDataHeaders() get data headers
HeaderRowContext	getHeaderRowContext()
java.util.List<IHeader>	getHeaders() get one-level header
int	getMaxHeaderNum() 获取最大header列号,从1开始
java.lang.String	getName()
java.util.List<RowTrigger>	getRowTriggers(IHeader header)
java.util.List<RowTrigger>	getRowTriggers(int headerColumnNum)
int	getStartHeaderNum()
boolean	hasRowTrigger()
boolean	isFlushed()
boolean	isIndex() 有索引属性
boolean	matchColumnNum(int columnNum, java.lang.String... labels) 列号是否匹配于当前列名称
static HeadersFactory	newBuild() Headers工厂构建类
void	setDefaultDataCellStyle(IWrapCellStyle defaultDataCellStyle)
void	setDefaultHeaderCellStyle(IWrapCellStyle defaultHeaderCellStyle)
Headers	skipColumns(int columnCount) skip some columns
Headers	skipToOneColumn(int columnNum) skip to one column, only go the bigger column
Headers	skipToOneColumn(java.lang.String columnNo)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

INDEX_TAG

public static final java.lang.String INDEX_TAG

另请参阅:

常量字段值

DEFAULT_HEADERS

public static final java.lang.String DEFAULT_HEADERS

另请参阅:

常量字段值

rowTriggerMap

protected java.util.Map<IHeader,java.util.List<RowTrigger>> rowTriggerMap

headerRowContext

protected HeaderRowContext headerRowContext

flushed

protected boolean flushed

添加header后是否调用过flush

构造器详细资料

Headers

public Headers()

Headers

public Headers(java.lang.String name)

Headers

public Headers(int startHeaderNum)

Headers

public Headers(int startHeaderNum,
               java.lang.String name)

构造

参数:

startHeaderNum - 头信息的开始索引,从1开始

方法详细资料

newBuild

public static HeadersFactory newBuild()

Headers工厂构建类

getName

public java.lang.String getName()

skipColumns

public Headers skipColumns(int columnCount)

skip some columns

参数:

columnCount - column's num

返回:

Headers

skipToOneColumn

public Headers skipToOneColumn(int columnNum)

skip to one column, only go the bigger column

参数:

columnNum - column num, base 1

返回:

Headers

skipToOneColumn

public Headers skipToOneColumn(java.lang.String columnNo)

另请参阅:

skipToOneColumn(int)

addHeaders

public void addHeaders(java.util.Map<java.lang.String,java.lang.String> headerAlias)

addHeader

public IDataHeader addHeader(IDataHeader header)

添加数据header

addHeader

public ICustomHeader addHeader(ICustomHeader header)

添加自定义header

addHeader

public IGroupHeader addHeader(IGroupHeader header)

添加分组header

addHeader

public IDataHeader addHeader(java.lang.String label,
                             java.lang.String value,
                             IWrapCellStyle headerCellStyle,
                             IWrapCellStyle dataCellStyle)

添加默认头

参数:

label - label

value - value

headerCellStyle - 头样式

dataCellStyle - 数据样式

addHeader

public IDataHeader addHeader(java.lang.String label,
                             java.lang.String value)

另请参阅:

addHeader(String, String, IWrapCellStyle, IWrapCellStyle)

addArrayHeader

public IDataHeader addArrayHeader(java.lang.String label,
                                  java.lang.String value,
                                  ArrayMeta meta,
                                  IWrapCellStyle headerCellStyle,
                                  IWrapCellStyle dataCellStyle)

添加array头信息

参数:

label - label

value - value

meta - meta

headerCellStyle - 头样式

dataCellStyle - 数据样式

addArrayHeader

public IDataHeader addArrayHeader(java.lang.String label,
                                  java.lang.String value,
                                  ArrayMeta meta)

另请参阅:

addArrayHeader(String, String, ArrayMeta, IWrapCellStyle, IWrapCellStyle)

addTreeHeader

public IDataHeader addTreeHeader(java.lang.String label,
                                 java.lang.String value,
                                 TreeMeta meta,
                                 IDataHeader referHeader,
                                 IWrapCellStyle headerCellStyle,
                                 IWrapCellStyle dataCellStyle)

添加tree头信息

参数:

label - label

value - value

meta - meta

referHeader - 引用头信息

headerCellStyle - 头样式

dataCellStyle - 数据样式

addTreeHeader

public IDataHeader addTreeHeader(java.lang.String label,
                                 java.lang.String value,
                                 TreeMeta meta,
                                 java.lang.String referHeaderName,
                                 IWrapCellStyle headerCellStyle,
                                 IWrapCellStyle dataCellStyle)

添加tree头信息

参数:

label - label

value - value

meta - meta

referHeaderName - 引用头信息名称

headerCellStyle - 头样式

dataCellStyle - 数据样式

返回:

数据header

addTreeHeader

public IDataHeader addTreeHeader(java.lang.String label,
                                 java.lang.String value,
                                 TreeMeta meta,
                                 IWrapCellStyle headerCellStyle,
                                 IWrapCellStyle dataCellStyle)

添加第一层header信息

参数:

label - label

value - value

meta - meta

headerCellStyle - 头样式

dataCellStyle - 数据样式

addTreeHeader

public IDataHeader addTreeHeader(java.lang.String label,
                                 java.lang.String value,
                                 TreeMeta meta,
                                 IDataHeader referHeader)

另请参阅:

addTreeHeader(String, String, TreeMeta, IDataHeader, IWrapCellStyle, IWrapCellStyle)

addTreeHeader

public IDataHeader addTreeHeader(java.lang.String label,
                                 java.lang.String value,
                                 TreeMeta meta,
                                 java.lang.String referHeaderName)

另请参阅:

addTreeHeader(String, String, TreeMeta, String)

addTreeHeader

public IDataHeader addTreeHeader(java.lang.String label,
                                 java.lang.String value,
                                 TreeMeta meta)

addSequenceHeader

public ICustomHeader addSequenceHeader(java.lang.String value)

添加序列header

参数:

value - value

addSequenceHeader

public ICustomHeader addSequenceHeader(java.lang.String value,
                                       IDataHeader sameLevelHeader)

flush

public void flush()

刷新headers

     刷新header引用: 一些header在引用其他header时,使用的是名字引用，而非对象; 因此需要帮助重新设置对象,确保对象存在
 

getHeaders

public java.util.List<IHeader> getHeaders()

get one-level header

返回:

one-level headers

getCustomHeaders

public java.util.List<ICustomHeader> getCustomHeaders()

获取自定义header

getDataHeaders

public java.util.List<IDataHeader> getDataHeaders()

get data headers

返回:

all data headers

getStartHeaderNum

public int getStartHeaderNum()

getMaxHeaderNum

public int getMaxHeaderNum()

获取最大header列号,从1开始

getDataHeaderByColumnNum

public IDataHeader getDataHeaderByColumnNum(int columnNum)

get data-header by column num

参数:

columnNum - column num, base 1

返回:

头信息

getDataHeaderByLabel

public IDataHeader getDataHeaderByLabel(java.lang.String label)

get data header by label

参数:

label - header label

matchColumnNum

public boolean matchColumnNum(int columnNum,
                              java.lang.String... labels)

列号是否匹配于当前列名称

参数:

columnNum - 列号

labels - 列名称集合

返回:

是否匹配

isIndex

public boolean isIndex()

有索引属性

createHeaderCells

public java.util.List<IMergedCell> createHeaderCells(int startRowNum)

create cells of the header

参数:

startRowNum - start row num

返回:

header cells

setDefaultHeaderCellStyle

public void setDefaultHeaderCellStyle(IWrapCellStyle defaultHeaderCellStyle)

setDefaultDataCellStyle

public void setDefaultDataCellStyle(IWrapCellStyle defaultDataCellStyle)

addRowTrigger

public void addRowTrigger(IDataHeader header,
                          RowTrigger trigger)

addRowTrigger

public void addRowTrigger(java.lang.String headerName,
                          RowTrigger trigger)

getRowTriggers

public java.util.List<RowTrigger> getRowTriggers(IHeader header)

getRowTriggers

public java.util.List<RowTrigger> getRowTriggers(int headerColumnNum)

hasRowTrigger

public boolean hasRowTrigger()

getHeaderRowContext

public HeaderRowContext getHeaderRowContext()

isFlushed

public boolean isFlushed()