FontStream (orion-kit 2.0.2 API)

java.lang.Object
- cn.orionsec.kit.office.excel.style.FontStream

```
public class FontStream
extends Object
```
excel 字体样式

Since:

2020/5/23 17:11

Version:

1.0.0

Author:

Jiahang Li

Constructor Summary

Constructors
Constructor and Description
`FontStream(org.apache.poi.ss.usermodel.Workbook workbook)`
`FontStream(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Font font)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FontStream`	`ansiCharset()` 设置系统编码
`FontStream`	`black()` 设置黑色
`FontStream`	`blue()` 设置蓝色
`FontStream`	`bold()` 设置加粗
`FontStream`	`bold(boolean set)` 设置加粗
`FontStream`	`bottomOffset()` 设置偏移到底部
`FontStream`	`charset(int charset)` 设置编码
`FontStream`	`color(byte[] c)` 设置颜色
`FontStream`	`color(int c)` 设置颜色
`FontStream`	`color(short index, byte[] c)` 设置颜色
`FontStream`	`color(short index, String c)` 设置颜色
`FontStream`	`color(String c)` 设置颜色
`FontStream`	`defaultCharset()` 设置默认编码
`FontStream`	`deleteLine()` 设置删除线
`FontStream`	`deleteLine(boolean set)` 设置删除线
`FontStream`	`family(int i)` 设置字体家族
`static FontStream`	`fontStream(org.apache.poi.ss.usermodel.Workbook workbook)` 获取 FontStream
`static FontStream`	`fontStream(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Font font)` 获取 FontStream
`int`	`getCharset()` 获取编码格式
`short`	`getColor()` 获取颜色编码
`int`	`getFamily()` 获取字体家族
`org.apache.poi.ss.usermodel.Font`	`getFont()`
`String`	`getFontName()` 获取字体名称
`int`	`getFontSize()` 获取字体大小
`short`	`getOffsetType()` 获取偏移类型
`int`	`getScheme()` 获取属性
`int`	`getThemeColor()` 获取主题颜色
`byte`	`getUnderLineType()` 获取下滑线类型
`org.apache.poi.ss.usermodel.Workbook`	`getWorkbook()`
`FontStream`	`indigo()` 设置靛青色
`boolean`	`isBold()` 是否为加粗字体
`boolean`	`isDelete()` 是否为删除线
`boolean`	`isItalic()` 是否为斜体
`FontStream`	`italic()` 设置斜体
`FontStream`	`italic(boolean set)` 设置斜体
`FontStream`	`name(String name)` 设置字体名称
`static org.apache.poi.ss.usermodel.Font`	`parseFont(org.apache.poi.ss.usermodel.Workbook workbook, FontOption option)` 解析 font
`FontStream`	`pink()` 设置粉色
`FontStream`	`red()` 设置红色
`FontStream`	`scheme(int i)` 设置属性
`FontStream`	`size(int size)` 设置字体大小
`FontStream`	`symbolCharset()` 设置符号编码
`FontStream`	`themesColor(int i)` 设置主题颜色
`FontStream`	`themesTable(org.apache.poi.xssf.model.ThemesTable table)` 设置主题表格
`FontStream`	`topOffset()` 设置偏移到顶部
`FontStream`	`typeOffset(int offset)` 设置偏移
`FontStream`	`underDoubleLine()` 设置双下划线
`FontStream`	`underLine()` 设置下滑线
`FontStream`	`underLine(int line)` 设置下滑线
`FontStream`	`unsetBold()` 不设置加粗
`FontStream`	`unsetDeleteLine()` 不设置删除线
`FontStream`	`unsetFamily()` 不设置字体家族
`FontStream`	`unsetItalic()` 不设置斜体
`FontStream`	`unsetOffset()` 不设置偏移
`FontStream`	`unsetScheme()` 设置属性
`FontStream`	`unsetUnderLine()` 不设置下滑线

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FontStream
```
public FontStream(org.apache.poi.ss.usermodel.Workbook workbook)
```
  - FontStream
```
public FontStream(org.apache.poi.ss.usermodel.Workbook workbook,
                  org.apache.poi.ss.usermodel.Font font)
```
- Method Detail
  - fontStream
```
public static FontStream fontStream(org.apache.poi.ss.usermodel.Workbook workbook)
```
    获取 FontStream
    
    Parameters:
    
    workbook - Workbook
    
    Returns:
    
    FontStream
  - fontStream
```
public static FontStream fontStream(org.apache.poi.ss.usermodel.Workbook workbook,
                                    org.apache.poi.ss.usermodel.Font font)
```
    获取 FontStream
    
    Parameters:
    
    workbook - Workbook
    
    font - Font
    
    Returns:
    
    FontStream
  - parseFont
```
public static org.apache.poi.ss.usermodel.Font parseFont(org.apache.poi.ss.usermodel.Workbook workbook,
                                                         FontOption option)
```
    解析 font
    
    Parameters:
    
    workbook - workbook
    
    option - option
    
    Returns:
    
    font
  - name
```
public FontStream name(String name)
```
    设置字体名称
    
    Parameters:
    
    name - 名称
    
    Returns:
    
    this
  - size
```
public FontStream size(int size)
```
    设置字体大小
    
    Parameters:
    
    size - size
    
    Returns:
    
    this
  - deleteLine
```
public FontStream deleteLine()
```
    设置删除线
    
    Returns:
    
    this
  - unsetDeleteLine
```
public FontStream unsetDeleteLine()
```
    不设置删除线
    
    Returns:
    
    this
  - deleteLine
```
public FontStream deleteLine(boolean set)
```
    设置删除线
    
    Parameters:
    
    set - 是否设置
    
    Returns:
    
    this
  - underLine
```
public FontStream underLine()
```
    设置下滑线
    
    Returns:
    
    this
  - unsetUnderLine
```
public FontStream unsetUnderLine()
```
    不设置下滑线
    
    Returns:
    
    this
  - underLine
```
public FontStream underLine(int line)
```
    设置下滑线
    
    Parameters:
    
    line - 下滑线类型
    
    Returns:
    
    this
  - underDoubleLine
```
public FontStream underDoubleLine()
```
    设置双下划线
    
    Returns:
    
    this
  - italic
```
public FontStream italic()
```
    设置斜体
    
    Returns:
    
    this
  - unsetItalic
```
public FontStream unsetItalic()
```
    不设置斜体
    
    Returns:
    
    this
  - italic
```
public FontStream italic(boolean set)
```
    设置斜体
    
    Parameters:
    
    set - 是否设置
    
    Returns:
    
    this
  - bold
```
public FontStream bold()
```
    设置加粗
    
    Returns:
    
    this
  - unsetBold
```
public FontStream unsetBold()
```
    不设置加粗
    
    Returns:
    
    this
  - bold
```
public FontStream bold(boolean set)
```
    设置加粗
    
    Parameters:
    
    set - 是否设置
    
    Returns:
    
    this
  - typeOffset
```
public FontStream typeOffset(int offset)
```
    设置偏移
    
    Parameters:
    
    offset - 0不偏移 1顶部偏移 2底部偏移
    
    Returns:
    
    this
  - unsetOffset
```
public FontStream unsetOffset()
```
    不设置偏移
    
    Returns:
    
    this
  - topOffset
```
public FontStream topOffset()
```
    设置偏移到顶部
    
    Returns:
    
    this
  - bottomOffset
```
public FontStream bottomOffset()
```
    设置偏移到底部
    
    Returns:
    
    this
  - charset
```
public FontStream charset(int charset)
```
    设置编码
    
    Parameters:
    
    charset - 0系统 1默认 2符号
    
    Returns:
    
    this
  - ansiCharset
```
public FontStream ansiCharset()
```
    设置系统编码
    
    Returns:
    
    this
  - defaultCharset
```
public FontStream defaultCharset()
```
    设置默认编码
    
    Returns:
    
    this
  - symbolCharset
```
public FontStream symbolCharset()
```
    设置符号编码
    
    Returns:
    
    this
  - color
```
public FontStream color(int c)
```
    设置颜色
    
    Returns:
    
    this
  - color
```
public FontStream color(byte[] c)
```
    设置颜色
    
    Parameters:
    
    c - rgb
    
    Returns:
    
    this
  - color
```
public FontStream color(short index,
                        byte[] c)
```
    设置颜色
    
    Parameters:
    
    index - 调色板颜色覆盖索引
    
    c - rgb
    
    Returns:
    
    this
  - color
```
public FontStream color(String c)
```
    设置颜色
    
    Parameters:
    
    c - #
    
    Returns:
    
    this
  - color
```
public FontStream color(short index,
                        String c)
```
    设置颜色
    
    Parameters:
    
    index - 调色板颜色覆盖索引
    
    c - #
    
    Returns:
    
    this
  - blue
```
public FontStream blue()
```
    设置蓝色
    
    Returns:
    
    this
  - black
```
public FontStream black()
```
    设置黑色
    
    Returns:
    
    this
  - red
```
public FontStream red()
```
    设置红色
    
    Returns:
    
    this
  - pink
```
public FontStream pink()
```
    设置粉色
    
    Returns:
    
    this
  - indigo
```
public FontStream indigo()
```
    设置靛青色
    
    Returns:
    
    this
  - family
```
public FontStream family(int i)
```
    设置字体家族
    
    Parameters:
    
    i - NOT_APPLICABLE 0 ROMAN 1 SWISS 2 MODERN 3 SCRIPT 4 DECORATIVE 5
    
    Returns:
    
    this
  - unsetFamily
```
public FontStream unsetFamily()
```
    不设置字体家族
    
    Returns:
    
    this
  - scheme
```
public FontStream scheme(int i)
```
    设置属性
    
    Parameters:
    
    i - NONE 1 MAJOR 2 MINOR 3
    
    Returns:
    
    this
  - unsetScheme
```
public FontStream unsetScheme()
```
    设置属性
    
    Returns:
    
    this
  - themesTable
```
public FontStream themesTable(org.apache.poi.xssf.model.ThemesTable table)
```
    设置主题表格
    
    Parameters:
    
    table - table
    
    Returns:
    
    this
  - themesColor
```
public FontStream themesColor(int i)
```
    设置主题颜色
    
    Parameters:
    
    i - 颜色
    
    Returns:
    
    this
  - getWorkbook
```
public org.apache.poi.ss.usermodel.Workbook getWorkbook()
```
  - getFont
```
public org.apache.poi.ss.usermodel.Font getFont()
```
  - getFontSize
```
public int getFontSize()
```
    获取字体大小
    
    Returns:
    
    字体大小
  - getFontName
```
public String getFontName()
```
    获取字体名称
    
    Returns:
    
    字体名称
  - isBold
```
public boolean isBold()
```
    是否为加粗字体
    
    Returns:
    
    true加粗
  - isItalic
```
public boolean isItalic()
```
    是否为斜体
    
    Returns:
    
    true斜体
  - isDelete
```
public boolean isDelete()
```
    是否为删除线
    
    Returns:
    
    true删除线
  - getUnderLineType
```
public byte getUnderLineType()
```
    获取下滑线类型
    
    Returns:
    
    0无 1单下滑线 2双下滑线
  - getCharset
```
public int getCharset()
```
    获取编码格式
    
    Returns:
    
    0系统编码 1默认编码 2符号编码
  - getOffsetType
```
public short getOffsetType()
```
    获取偏移类型
    
    Returns:
    
    0不偏移 1上对齐 2下对齐
  - getColor
```
public short getColor()
```
    获取颜色编码
    
    Returns:
    
    颜色编码
  - getFamily
```
public int getFamily()
```
    获取字体家族
    
    Returns:
    
    family
  - getScheme
```
public int getScheme()
```
    获取属性
    
    Returns:
    
    scheme
  - getThemeColor
```
public int getThemeColor()
```
    获取主题颜色
    
    Returns:
    
    color

Class FontStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FontStream

FontStream

Method Detail

fontStream

fontStream

parseFont

name

size

deleteLine

unsetDeleteLine

deleteLine

underLine

unsetUnderLine

underLine

underDoubleLine

italic

unsetItalic

italic

bold

unsetBold

bold

typeOffset

unsetOffset

topOffset

bottomOffset

charset

ansiCharset

defaultCharset

symbolCharset

color

color

color

color

color

blue

black

red

pink

indigo

family

unsetFamily

scheme

unsetScheme

themesTable

themesColor

getWorkbook

getFont

getFontSize

getFontName

isBold

isItalic

isDelete

getUnderLineType

getCharset

getOffsetType

getColor

getFamily

getScheme

getThemeColor