NumFmt (Excel Write/Read Framework 0.5.26 API)

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

所有已实现的接口:

Cloneable, Comparable<NumFmt>
```
public class NumFmt
extends Object
implements Cloneable, Comparable<NumFmt>
```
To create a custom number format, you start by selecting one of the built-in number formats as a starting point. You can then change any one of the code sections of that format to create your own custom number format.
A number format can have up to four sections of code, separated by semicolons. These code sections define the format for positive numbers, negative numbers, zero values, and text, in that order.
<POSITIVE>;<NEGATIVE>;<ZERO>;<TEXT>
For example, you can use these code sections to create the following custom format:
[Blue]#,##0.00_);[Red](#,##0.00);0.00;"sales "@
You do not have to include all code sections in your custom number format. If you specify only two code sections for your custom number format, the first section is used for positive numbers and zeros, and the second section is used for negative numbers. If you specify only one code section, it is used for all numbers. If you want to skip a code section and include a code section that follows it, you must include the ending semicolon for the section that you skip.
作者:

guanquan.wang at 2018-02-06 08:51

字段概要

字段
限定符和类型	字段和说明
`protected String`	`code`
`protected Map<String,Integer>`	`codeWidthCache` 缓存code的宽度 key: 字号+字体 value: 预计算的结果
`static NumFmt`	`DATE_FORMAT` Format as `yyyy-mm-dd hh:mm:ss`
`static NumFmt`	`DATETIME_FORMAT` Format as `yyyy-mm-dd hh:mm:ss`
`protected int`	`id`
`static NumFmt`	`TIME_FORMAT` Format as `yyyy-mm-dd hh:mm:ss`

构造器概要

构造器
构造器和说明

NumFmt()

NumFmt(String code)

构造器
构造器和说明
`NumFmt()`
`NumFmt(String code)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`double`	`calcNumWidth(double base, Font font)` 粗略计算单元格长度，优先从缓存中获取预处理结果，缓存key由字号+字体名组成这样就保存能计算出相近的宽度，未命中缓存则从先预处理再丢入缓存以便下次使用
`NumFmt`	`clone()`
`int`	`compareTo(NumFmt o)`
`static List<NumFmt>`	`domToNumFmt(org.dom4j.Element root)`
`boolean`	`equals(Object o)`
`String`	`getCode()`
`protected int`	`getCodeWidthFromCache(Font font)` 计算并缓存格式化串的长度，以此长度为基础计算文本长度
`int`	`getId()`
`int`	`hashCode()`
`static NumFmt`	`of(String code)` Create a NumFmt
`void`	`setCode(String code)`
`org.dom4j.Element`	`toDom(org.dom4j.Element root)`
`String`	`toString()`
`static NumFmt`	`valueOf(int id)` Built-In number format

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

- 字段详细资料
  - DATETIME_FORMAT
```
public static final NumFmt DATETIME_FORMAT
```
    Format as yyyy-mm-dd hh:mm:ss
  - DATE_FORMAT
```
public static final NumFmt DATE_FORMAT
```
    Format as yyyy-mm-dd hh:mm:ss
  - TIME_FORMAT
```
public static final NumFmt TIME_FORMAT
```
    Format as yyyy-mm-dd hh:mm:ss
  - code
```
protected String code
```
  - id
```
protected int id
```
  - codeWidthCache
```
protected transient Map<String,Integer> codeWidthCache
```
    缓存code的宽度 key: 字号+字体 value: 预计算的结果
- 构造器详细资料
  - NumFmt
```
public NumFmt()
```
  - NumFmt
```
public NumFmt(String code)
```
- 方法详细资料
  - getCode
```
public String getCode()
```
  - setCode
```
public void setCode(String code)
```
  - getId
```
public int getId()
```
  - valueOf
```
public static NumFmt valueOf(int id)
```
    Built-In number format
    
    参数:
    
    id - the built-in id
    
    返回:
    
    the NumFmt
  - of
```
public static NumFmt of(String code)
```
    Create a NumFmt
    
    参数:
    
    code - the numFmt code string
    
    返回:
    
    NumFmt
  - calcNumWidth
```
public double calcNumWidth(double base,
                           Font font)
```
    粗略计算单元格长度，优先从缓存中获取预处理结果，缓存key由字号+字体名组成这样就保存能计算出相近的宽度，未命中缓存则从先预处理再丢入缓存以便下次使用
    
    参数:
    
    base - the cell value length
    
    font - font
    
    返回:
    
    cell length
  - getCodeWidthFromCache
```
protected int getCodeWidthFromCache(Font font)
```
    计算并缓存格式化串的长度，以此长度为基础计算文本长度
    
    参数:
    
    font - 字体
    
    返回:
    
    一个二进制结果，第0位表示日期，第1位表示是否有逗号分隔符，当第0位为1时高30位保存格式化串的宽度（已按字体计算好的宽度），当第0位为0时第2-9位表示小数点后面的位数，10-31位表示单字节单个字符宽度
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - toDom
```
public org.dom4j.Element toDom(org.dom4j.Element root)
```
  - domToNumFmt
```
public static List<NumFmt> domToNumFmt(org.dom4j.Element root)
```
  - compareTo
```
public int compareTo(NumFmt o)
```
    指定者:
    
    compareTo 在接口中 Comparable<NumFmt>
  - clone
```
public NumFmt clone()
```
    覆盖:
    
    clone 在类中 Object

类 NumFmt

字段概要

构造器概要

方法概要

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

字段详细资料

DATETIME_FORMAT

DATE_FORMAT

TIME_FORMAT

code

id

codeWidthCache

构造器详细资料

NumFmt

NumFmt

方法详细资料

getCode

setCode

getId

valueOf

of

calcNumWidth

getCodeWidthFromCache

hashCode

equals

toString

toDom

domToNumFmt

compareTo

clone