Styles (Excel Write/Read Framework 0.5.25 API)

java.lang.Object
- org.ttzero.excel.entity.style.Styles

所有已实现的接口:

Storable
```
@TopNS(prefix="",
       uri="http://schemas.openxmlformats.org/spreadsheetml/2006/main",
       value="styleSheet")
public class Styles
extends Object
implements Storable
```
Excel样式包含格式化NumFmt、字体Font、填充Fill、边框Border、垂直对齐Verticals和水平对齐Horizontals以及自动折行组成，样式存放在共享区域供多个工作表共用，每个样式值都是由这7种值进行组合而来。全局样式库统管样式读写，添加样式时会查询当前样式是否已存在，如果存在则直接返回该样式在库中的索引值否则添加到样式库末尾
本工具简化了样式设计，基础的4种样式由数组保存，单元格样式值由一个int值保存，它可以极大压缩内存消耗和快速查找，但短板是可用的样式减少，最多只能包含256个格式化，64个字体，填充和边框，对于日常的导出来说应该是够用的，复杂场景就需要考虑将int扩大到long

由于使用2进制位点保存各个样式，所以要修改样式时必须先清除原位点上的值然后再添加新样式，否则位点在进行“或”运行时将保留全部1 致使样式错乱，可以直接使用位运算来处理样式，也可以通过Styles.modify开头的方法来修改
```
  Bit  | Contents
 ------+---------
  0, 1 | 自动折行
  1, 3 | 水平对齐
  4, 2 | 垂直对齐
  6, 6 | 边框
 12, 6 | 填充
 18, 6 | 字体
 24. 8 | 格式化
```
作者:

guanquan.wang on 2017/10/13.

字段概要

字段
限定符和类型	字段和说明
`static int`	`INDEX_BORDER`
`static int`	`INDEX_FILL`
`static int`	`INDEX_FONT`
`static int`	`INDEX_HORIZONTAL`
`static int`	`INDEX_NUMBER_FORMAT`
`static int`	`INDEX_VERTICAL`
`static int`	`INDEX_WRAP_TEXT`
`Color[]`	`indexedColors`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`int`	`addBorder(Border border)` 添加“边框” 返回样式值中“边框”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
`void`	`addDateFmtCache(int xf)` Append a date format back into cache
`int`	`addFill(Fill fill)` 添加“填充” 返回样式值中“填充”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
`int`	`addFont(Font font)` 添加“字体” 返回样式值中“字体”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
`int`	`addNumFmt(NumFmt numFmt)` 添加“格式化”，对格式化串去重处理返回样式值中“格式化”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
`static int`	`clearBorder(int style)` 清除样式中的“边框”
`static int`	`clearFill(int style)` 清除样式中的“填充”
`static int`	`clearFont(int style)` 清除样式中的“字体”
`static int`	`clearHorizontal(int style)` 清除样式中的“水平对齐”
`static int`	`clearNumFmt(int style)` 清除样式中的“格式化”
`static int`	`clearVertical(int style)` 清除样式中的“垂直对齐”
`static int`	`clearWrapText(int style)` 清除样式中的“自动折行”
`static Styles`	`create()` Create a general style
`static org.dom4j.Document`	`createDocument()`
`static int`	`defaultCharBorderStyle()`
`static int`	`defaultCharStyle()`
`static int`	`defaultDoubleBorderStyle()`
`static int`	`defaultDoubleStyle()`
`static int`	`defaultIntBorderStyle()`
`static int`	`defaultIntStyle()`
`static int`	`defaultStringBorderStyle()`
`static int`	`defaultStringStyle()`
`static Styles`	`forReader()` Create a general style
`static String`	`getAttr(org.dom4j.Element element, String attr)` Returns the attribute value from Element
`Border`	`getBorder(int style)` 获取样式中的边框
`Fill`	`getFill(int style)` 获取样式中的格式化
`Font`	`getFont(int style)` 获取样式中的字体
`int`	`getHorizontal(int style)` 获取样式中的水平对齐，参考范围`Horizontals`
`NumFmt`	`getNumFmt(int style)` 获取样式中的格式化值
`int`	`getStyleByIndex(int styleIndex)` 通过样式索引查询样式值
`int`	`getVertical(int style)` 获取样式中的垂直对齐，参考范围`Verticals`
`int`	`getWrapText(int style)` 获取样式中自动折行标记，标记为`1`时表示自动折行
`static boolean`	`hasBorder(int style)` 判断样式是否包含“边框"
`static boolean`	`hasFill(int style)` 判断样式是否包含“填充"
`static boolean`	`hasFont(int style)` 判断样式是否包含“字体"
`static boolean`	`hasHorizontal(int style)` 判断样式是否包含“水平对齐"
`static boolean`	`hasNumFmt(int style)` 判断样式是否包含“格式化"
`static boolean`	`hasVertical(int style)` 判断样式是否包含“垂直对齐"
`static boolean`	`hasWrapText(int style)` 判断样式是否自动折行
`boolean`	`isDate(int styleIndex)` Test the style is data format
`static Styles`	`load(InputStream is)` Load the style file from disk
`int`	`modifyBorder(int style, Border newBorder)` 修改“边框”样式
`int`	`modifyFill(int style, Fill newFill)` 修改“填充”样式
`int`	`modifyFont(int style, Font newFont)` 修改“字体”样式
`int`	`modifyHorizontal(int style, int newHorizontal)` 修改“水平对齐”样式
`int`	`modifyNumFmt(int style, NumFmt newNumFmt)` 修改“格式化”样式
`int`	`modifyVertical(int style, int newVertical)` 修改“垂直对齐”样式
`int`	`modifyWrapText(int style, boolean newWrapText)` 修改"自动折行"样式
`int`	`of(int s)` 向全局样式库中添加样式，添加前会先查询是否已有相同样式，如果有则直接返回该样式在全局样式库中的索引值，不存在则将该样式添加到样式库末尾
`static int`	`pack(int[] styles)`
`static Color`	`parseColor(org.dom4j.Element element)` Parse color tag
`int`	`size()` Returns the number of styles
`static boolean`	`testCodeIsDate(String code)`
`static Color`	`toColor(String v)` Converts a `String` to an integer and returns the specified opaque `Color`.
`static int[]`	`unpack(int style)`
`void`	`writeTo(Path styleFile)` Write style to disk

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

- 字段详细资料
  - indexedColors
```
public Color[] indexedColors
```
  - INDEX_NUMBER_FORMAT
```
public static final int INDEX_NUMBER_FORMAT
```
    另请参阅:
    
    常量字段值
  - INDEX_FONT
```
public static final int INDEX_FONT
```
    另请参阅:
    
    常量字段值
  - INDEX_FILL
```
public static final int INDEX_FILL
```
    另请参阅:
    
    常量字段值
  - INDEX_BORDER
```
public static final int INDEX_BORDER
```
    另请参阅:
    
    常量字段值
  - INDEX_VERTICAL
```
public static final int INDEX_VERTICAL
```
    另请参阅:
    
    常量字段值
  - INDEX_HORIZONTAL
```
public static final int INDEX_HORIZONTAL
```
    另请参阅:
    
    常量字段值
  - INDEX_WRAP_TEXT
```
public static final int INDEX_WRAP_TEXT
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - of
```
public int of(int s)
```
    向全局样式库中添加样式，添加前会先查询是否已有相同样式，如果有则直接返回该样式在全局样式库中的索引值，不存在则将该样式添加到样式库末尾
    
    参数:
    
    s - 样式值
    
    返回:
    
    样式索引
  - getStyleByIndex
```
public int getStyleByIndex(int styleIndex)
```
    通过样式索引查询样式值
    
    参数:
    
    styleIndex - 样式索引
    
    返回:
    
    样式值，查找失败时返回0 表示默认样式
  - size
```
public int size()
```
    Returns the number of styles
    
    返回:
    
    the total styles
  - create
```
public static Styles create()
```
    Create a general style
    
    返回:
    
    Styles
  - modifyBorder
```
public int modifyBorder(int style,
                        Border newBorder)
```
    修改“边框”样式
    
    参数:
    
    style - 原样式值
    
    newBorder - 新“边框”样式
    
    返回:
    
    新样式值
  - modifyNumFmt
```
public int modifyNumFmt(int style,
                        NumFmt newNumFmt)
```
    修改“格式化”样式
    
    参数:
    
    style - 原样式值
    
    newNumFmt - 新“格式化”样式
    
    返回:
    
    新样式值
  - modifyWrapText
```
public int modifyWrapText(int style,
                          boolean newWrapText)
```
    修改"自动折行"样式
    
    参数:
    
    style - 原样式值
    
    newWrapText - true: 自动折行
    
    返回:
    
    新样式值
  - modifyVertical
```
public int modifyVertical(int style,
                          int newVertical)
```
    修改“垂直对齐”样式
    
    参数:
    
    style - 原样式值
    
    newVertical - 新“垂直对齐”样式，必须使用Verticals定义的静态值
    
    返回:
    
    新样式值
  - modifyHorizontal
```
public int modifyHorizontal(int style,
                            int newHorizontal)
```
    修改“水平对齐”样式
    
    参数:
    
    style - 原样式值
    
    newHorizontal - 新“水平对齐”样式，必须使用Horizontals定义的静态值
    
    返回:
    
    新样式值
  - modifyFill
```
public int modifyFill(int style,
                      Fill newFill)
```
    修改“填充”样式
    
    参数:
    
    style - 原样式值
    
    newFill - 新“填充”样式
    
    返回:
    
    新样式值
  - modifyFont
```
public int modifyFont(int style,
                      Font newFont)
```
    修改“字体”样式
    
    参数:
    
    style - 原样式值
    
    newFont - 新“字体”样式
    
    返回:
    
    新样式值
  - forReader
```
public static Styles forReader()
```
    Create a general style
    
    返回:
    
    Styles
  - load
```
public static Styles load(InputStream is)
```
    Load the style file from disk
    
    参数:
    
    is - the style InputStream
    
    返回:
    
    the Styles Object
  - addNumFmt
```
public final int addNumFmt(NumFmt numFmt)
```
    添加“格式化”，对格式化串去重处理
    返回样式值中“格式化”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
    
    参数:
    
    numFmt - 格式化NumFmt
    
    返回:
    
    样式值中“格式化”部分的2进制值
  - addFont
```
public final int addFont(Font font)
```
    添加“字体”
    返回样式值中“字体”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
    
    参数:
    
    font - 字体Font
    
    返回:
    
    样式值中“字体”部分的2进制值
  - addFill
```
public final int addFill(Fill fill)
```
    添加“填充”
    返回样式值中“填充”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
    
    参数:
    
    fill - 填充Font
    
    返回:
    
    样式值中“填充”部分的2进制值
  - addBorder
```
public final int addBorder(Border border)
```
    添加“边框”
    返回样式值中“边框”部分的2进制值，拿到这个值后可以与其它部分值进行“或”运算以组成最终的样式值
    
    参数:
    
    border - 边框Border
    
    返回:
    
    样式值中“边框”部分的2进制值
  - unpack
```
public static int[] unpack(int style)
```
  - pack
```
public static int pack(int[] styles)
```
  - writeTo
```
public void writeTo(Path styleFile)
             throws IOException
```
    Write style to disk
    
    指定者:
    
    writeTo 在接口中 Storable
    
    参数:
    
    styleFile - the storage path
    
    抛出:
    
    IOException - if I/O error occur
  - createDocument
```
public static org.dom4j.Document createDocument()
```
  - clearNumFmt
```
public static int clearNumFmt(int style)
```
    清除样式中的“格式化”
    
    参数:
    
    style - 样式值
    
    返回:
    
    清除“格式化”后的样式
  - clearFont
```
public static int clearFont(int style)
```
    清除样式中的“字体”
    
    参数:
    
    style - 样式值
    
    返回:
    
    清除“字体”后的样式
  - clearFill
```
public static int clearFill(int style)
```
    清除样式中的“填充”
    
    参数:
    
    style - 样式值
    
    返回:
    
    清除“填充”后的样式
  - clearBorder
```
public static int clearBorder(int style)
```
    清除样式中的“边框”
    
    参数:
    
    style - 样式值
    
    返回:
    
    清除“边框”后的样式
  - clearVertical
```
public static int clearVertical(int style)
```
    清除样式中的“垂直对齐”
    
    参数:
    
    style - 样式值
    
    返回:
    
    清除“垂直对齐”后的样式
  - clearHorizontal
```
public static int clearHorizontal(int style)
```
    清除样式中的“水平对齐”
    
    参数:
    
    style - 样式值
    
    返回:
    
    清除“水平对齐”后的样式
  - clearWrapText
```
public static int clearWrapText(int style)
```
    清除样式中的“自动折行”
    
    参数:
    
    style - 样式值
    
    返回:
    
    清除“自动折行”后的样式
  - defaultCharBorderStyle
```
public static int defaultCharBorderStyle()
```
  - defaultStringBorderStyle
```
public static int defaultStringBorderStyle()
```
  - defaultIntBorderStyle
```
public static int defaultIntBorderStyle()
```
  - defaultDoubleBorderStyle
```
public static int defaultDoubleBorderStyle()
```
  - defaultCharStyle
```
public static int defaultCharStyle()
```
  - defaultStringStyle
```
public static int defaultStringStyle()
```
  - defaultIntStyle
```
public static int defaultIntStyle()
```
  - defaultDoubleStyle
```
public static int defaultDoubleStyle()
```
  - hasNumFmt
```
public static boolean hasNumFmt(int style)
```
    判断样式是否包含“格式化"
    
    参数:
    
    style - 样式值
    
    返回:
    
    true: 包含”格式化“
  - hasFont
```
public static boolean hasFont(int style)
```
    判断样式是否包含“字体"
    
    参数:
    
    style - 样式值
    
    返回:
    
    true: 包含”字体“
  - hasFill
```
public static boolean hasFill(int style)
```
    判断样式是否包含“填充"
    
    参数:
    
    style - 样式值
    
    返回:
    
    true: 包含”填充“
  - hasBorder
```
public static boolean hasBorder(int style)
```
    判断样式是否包含“边框"
    
    参数:
    
    style - 样式值
    
    返回:
    
    true: 包含”边框“
  - hasVertical
```
public static boolean hasVertical(int style)
```
    判断样式是否包含“垂直对齐"
    
    参数:
    
    style - 样式值
    
    返回:
    
    true: 包含”垂直对齐“（非默认）
  - hasHorizontal
```
public static boolean hasHorizontal(int style)
```
    判断样式是否包含“水平对齐"
    
    参数:
    
    style - 样式值
    
    返回:
    
    true: 包含”水平对齐“（非默认）
  - hasWrapText
```
public static boolean hasWrapText(int style)
```
    判断样式是否自动折行
    
    参数:
    
    style - 样式值
    
    返回:
    
    true: 自动折行
  - getNumFmt
```
public NumFmt getNumFmt(int style)
```
    获取样式中的格式化值
    
    参数:
    
    style - 样式值
    
    返回:
    
    格式化或 null
  - getFill
```
public Fill getFill(int style)
```
    获取样式中的格式化
    
    参数:
    
    style - 样式值
    
    返回:
    
    当前样式包含的格式化，不含格式化时返回null
  - getFont
```
public Font getFont(int style)
```
    获取样式中的字体
    
    参数:
    
    style - 样式值
    
    返回:
    
    当前样式包含的字体，样式一定包含字体
  - getBorder
```
public Border getBorder(int style)
```
    获取样式中的边框
    
    参数:
    
    style - 样式值
    
    返回:
    
    当前样式包含的边框，不含边框时返回null
  - getVertical
```
public int getVertical(int style)
```
    获取样式中的垂直对齐，参考范围Verticals
    
    参数:
    
    style - 样式值
    
    返回:
    
    当前样式包含的垂直对齐
  - getHorizontal
```
public int getHorizontal(int style)
```
    获取样式中的水平对齐，参考范围Horizontals
    
    参数:
    
    style - 样式值
    
    返回:
    
    当前样式包含的水平对齐
  - getWrapText
```
public int getWrapText(int style)
```
    获取样式中自动折行标记，标记为1时表示自动折行
    
    参数:
    
    style - 样式值
    
    返回:
    
    1: 自动折行
  - getAttr
```
public static String getAttr(org.dom4j.Element element,
                             String attr)
```
    Returns the attribute value from Element
    
    参数:
    
    element - current element
    
    attr - the attr name
    
    返回:
    
    the attr value
  - parseColor
```
public static Color parseColor(org.dom4j.Element element)
```
    Parse color tag
    
    参数:
    
    element - color tag
    
    返回:
    
    awt.Color or null
  - isDate
```
public boolean isDate(int styleIndex)
```
    Test the style is data format
    
    参数:
    
    styleIndex - the style index
    
    返回:
    
    true if the style content data format
  - testCodeIsDate
```
public static boolean testCodeIsDate(String code)
```
  - addDateFmtCache
```
public void addDateFmtCache(int xf)
```
    Append a date format back into cache
    
    参数:
    
    xf - the XFRecord id
  - toColor
```
public static Color toColor(String v)
```
    Converts a String to an integer and returns the specified opaque Color. This method handles string formats that are used to represent octal and hexadecimal numbers.
    
    参数:
    
    v - hexadecimal numbers or color name
    
    返回:
    
    the new Color object.
    
    抛出:
    
    IllegalArgumentException - if convert failed.

类 Styles

字段概要

方法概要

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

字段详细资料

indexedColors

INDEX_NUMBER_FORMAT

INDEX_FONT

INDEX_FILL

INDEX_BORDER

INDEX_VERTICAL

INDEX_HORIZONTAL

INDEX_WRAP_TEXT

方法详细资料

of

getStyleByIndex

size

create

modifyBorder

modifyNumFmt

modifyWrapText

modifyVertical

modifyHorizontal

modifyFill

modifyFont

forReader

load

addNumFmt

addFont

addFill

addBorder

unpack

pack

writeTo

createDocument

clearNumFmt

clearFont

clearFill

clearBorder

clearVertical

clearHorizontal

clearWrapText

defaultCharBorderStyle

defaultStringBorderStyle

defaultIntBorderStyle

defaultDoubleBorderStyle

defaultCharStyle

defaultStringStyle

defaultIntStyle

defaultDoubleStyle

hasNumFmt

hasFont

hasFill

hasBorder

hasVertical

hasHorizontal

hasWrapText

getNumFmt

getFill

getFont

getBorder

getVertical

getHorizontal

getWrapText

getAttr

parseColor

isDate

testCodeIsDate

addDateFmtCache

toColor