Styles (Excel Write/Read Framework 0.4.9 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

Each excel style consists of NumFmt, Font, Fill, Border, Verticals and Horizontals, each Worksheet introduced by subscript.

EEC uses an Integer value to store Extended Format:

  Bit  | Contents
 ------+---------
  0, 8 | NumFmt
  8, 6 | Font
 14, 6 | Fill
 20, 6 | Border
 26, 3 | Vertical
 29, 3 | Horizontal

The Build-In number format does not write into styles.

作者:: 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`

方法概要

All Methods Static Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`int`	`addBorder(Border border)` Add border
`void`	`addDateFmtCache(int xf)` Append a date format back into cache
`int`	`addFill(Fill fill)` Add fill
`int`	`addFont(Font font)` Add font
`int`	`addNumFmt(NumFmt numFmt)` Add number format
`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 Styles`	`create(I18N i18N)` Create a general style
`static int`	`defaultCharBorderStyle()`
`static int`	`defaultCharStyle()`
`static int`	`defaultDoubleBorderStyle()`
`static int`	`defaultDoubleStyle()`
`static int`	`defaultIntBorderStyle()`
`static int`	`defaultIntStyle()`
`static int`	`defaultStringBorderStyle()`
`static int`	`defaultStringStyle()`
`boolean`	`fastTestDateFmt(int styleIndex)` Fast test cell value is data/time value
`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)`
`NumFmt`	`getNumFmt(int style)`
`int`	`getVertical(int style)`
`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)`
`boolean`	`isDate(int styleIndex)` Test the style is data format
`static Styles`	`load(Path path)` Load the style file from disk
`int`	`of(int s)` Returns the style index, if the style not exists it will be insert into styles
`static int`	`reset(int style, int newStyle)`
`int`	`size()` Returns the number of styles
`static boolean`	`testCodeIsDate(String code)`
`void`	`writeTo(Path styleFile)` Write style to disk

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

字段详细资料
- 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
```
  另请参阅:
  
  常量字段值

方法详细资料

of
```
public int of(int s)
```
Returns the style index, if the style not exists it will be insert into styles

参数:

s - the value of style

返回:

the style index

size
```
public int size()
```
Returns the number of styles

返回:

the total styles

create
```
public static Styles create(I18N i18N)
```
Create a general style

参数:

i18N - the I18N

返回:

Styles

forReader
```
public static Styles forReader()
```
Create a general style

返回:

Styles

load
```
public static Styles load(Path path)
```
Load the style file from disk

参数:

path - the style file path

返回:

the Styles Object

addNumFmt
```
public final int addNumFmt(NumFmt numFmt)
```
Add number format

参数:

numFmt - the NumFmt entry

返回:

the numFmt part value in style

addFont
```
public final int addFont(Font font)
```
Add font

参数:

font - the Font entry

返回:

the font part value in style

addFill
```
public final int addFill(Fill fill)
```
Add fill

参数:

fill - the Fill entry

返回:

the fill part value in style

addBorder
```
public final int addBorder(Border border)
```
Add border

参数:

border - the Border entry

返回:

the border part value in style

writeTo
```
public void writeTo(Path styleFile)
             throws IOException
```
Write style to disk

指定者:

writeTo 在接口中 Storable

参数:

styleFile - the storage path

抛出:

IOException - if I/O error occur

clearNumFmt

public static int clearNumFmt(int style)

clearFont

public static int clearFont(int style)

clearFill

public static int clearFill(int style)

clearBorder

public static int clearBorder(int style)

clearVertical

public static int clearVertical(int style)

clearHorizontal

public static int clearHorizontal(int style)

reset

public static int reset(int style,
                        int newStyle)

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)

hasFont

public static boolean hasFont(int style)

hasFill

public static boolean hasFill(int style)

hasBorder

public static boolean hasBorder(int style)

hasVertical

public static boolean hasVertical(int style)

hasHorizontal

public static boolean hasHorizontal(int style)

getNumFmt
```
public NumFmt getNumFmt(int style)
```

getFill
```
public Fill getFill(int style)
```

getFont
```
public Font getFont(int style)
```

getBorder
```
public Border getBorder(int style)
```

getVertical
```
public int getVertical(int style)
```

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

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)

fastTestDateFmt
```
public boolean fastTestDateFmt(int styleIndex)
```
Fast test cell value is data/time value

参数:

styleIndex - the style index

返回:

true if the style content data format

addDateFmtCache
```
public void addDateFmtCache(int xf)
```
Append a date format back into cache

参数:

xf - the XFRecord id

类 Styles

字段概要

方法概要

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

字段详细资料

INDEX_NUMBER_FORMAT

INDEX_FONT

INDEX_FILL

INDEX_BORDER

INDEX_VERTICAL

INDEX_HORIZONTAL

方法详细资料

of

size

create

forReader

load

addNumFmt

addFont

addFill

addBorder

writeTo

clearNumFmt

clearFont

clearFill

clearBorder

clearVertical

clearHorizontal

reset

defaultCharBorderStyle

defaultStringBorderStyle

defaultIntBorderStyle

defaultDoubleBorderStyle

defaultCharStyle

defaultStringStyle

defaultIntStyle

defaultDoubleStyle

hasNumFmt

hasFont

hasFill

hasBorder

hasVertical

hasHorizontal

getNumFmt

getFill

getFont

getBorder

getVertical

getAttr

isDate

testCodeIsDate

fastTestDateFmt

addDateFmtCache