org.ttzero.excel.entity.style

类 Font

java.lang.Object

org.ttzero.excel.entity.style.Font

所有已实现的接口:

Cloneable

直接已知子类:

Comments.Pr

public class Font
extends Object
implements Cloneable

字体，为了简化本字体包含颜色属性，在输出时包含颜色的字体将以指定颜色渲染， 注意：字体在全局样式中是共享的，如果要修改某个属性必须先调用clone()方法 复制一个字体然后再修改属性，这样才不会影响之前使用过此字体的文本

作者:

guanquan.wang at 2018-02-02 16:51

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Font.Style 字体样式

构造器概要

构造器

构造器和说明
Font(Font other)
Font(String name, double size)
Font(String name, double size, Color color)
Font(String name, double size, int style, Color color)
Font(String name, int size)
Font(String name, int size, Color color)
Font(String name, int size, int style, Color color)

方法概要

限定符和类型	方法和说明
Font	bold() 添加“粗休”样式 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	clone()
Font	delBold() 删除"加粗"样式 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	delDoubleUnderline() 删除"下划线"样式 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	delItalic() 删除"斜体"样式 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	delStrikeThru() 删除“删除线”样式 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	delUnderline() 删除"下划线"样式 注意：字体是全局共享的所以修改属性前需要先复制字体
static List<Font>	domToFont(org.dom4j.Element root) 解析字体
static List<Font>	domToFont(org.dom4j.Element root, Color[] indexedColors) 解析字体
Font	doubleUnderline() 添加“双下划线”样式 注意：字体是全局共享的所以修改属性前需要先复制字体
boolean	equals(Object o)
int	getCharset() 获取字符集
Color	getColor() 获取字体颜色，未主动设置时返回null，输出到xml时显示黑色
int	getFamily() 获取字体家族
FontMetrics	getFontMetrics() 通过Font获取FontMetrics用以计算文本宽度
static FontMetrics	getFontMetrics(Font font) 通过Font获取FontMetrics用以计算文本宽度
String	getName() 获取字体名
String	getScheme() 获取此字体所属的字体方案，有三种可能的取值"none","major"和"minor"
int	getSize() 获取去尾数后的字体大小10.5实际返回10
double	getSize2() 获取字体大小
int	getStyle() 获取字体样式，样式定义在Font.Style类中，建议直接调用专用方法isBold(), isUnderline(), isStrikeThru()和isItalic()方法， 它们直接返回boolean类型的值方便后续判断
int	hashCode()
boolean	isBold() 检查是否有“粗体”样式
boolean	isDoubleUnderline() 检查是否有“双下划线”样式
boolean	isItalic() 检查是否有“斜体”样式
boolean	isStrikeThru() 检查是否有“删除线”样式
boolean	isUnderline() 检查是否有“下划线”样式
Font	italic() 添加“斜体”样式 注意：字体是全局共享的所以修改属性前需要先复制字体
static Font	of(Font awtFont) 将java.awt.Font字体转为当前字体
static Font	parse(String fontString) 解析字符串为字体 italic_bold_underline_size_family_color or italic bold underline size family color eq: italic_bold_12_宋体 // 斜体 加粗 12号字 宋体 eq: bold underline 12 'Times New Roman' red // 加粗 12号字 Times New Roman字体 红字
static Font	parseFontTag(org.dom4j.Element tag) 解析xml内容创建字体
static int	round10(double v)
Font	setCharset(int charset) 设置字体的字符集 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	setColor(Color color) 设置字体颜色 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	setFamily(int family) 设置字体家族 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	setName(String name) 设置字体名 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	setScheme(String scheme) 设置此字体所属的字体方案，有三种可能的取值"none","major"和"minor" 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	setSize(double size) 设置字体大小 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	setSize(int size) 设置字体大小 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	setStyle(int style) 设置字体样式，样式定义在Font.Style类中，建议直接调用专用方法bold(), underline(), strikeThru()和italic()方法设置， 这几个方法可以组合调用最终效果为组合效果 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	strikeThru() 添加“删除线”样式 注意：字体是全局共享的所以修改属性前需要先复制字体
Font	toAwtFont() 将当前字体转为 Font字体
org.dom4j.Element	toDom(org.dom4j.Element root) 输出为dom树
String	toString()
Font	underline() 添加“下划线”样式 注意：字体是全局共享的所以修改属性前需要先复制字体

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

finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

Font

public Font(String name,
            int size)

Font

public Font(String name,
            int size,
            Color color)

Font

public Font(String name,
            int size,
            int style,
            Color color)

Font

public Font(String name,
            double size)

Font

public Font(String name,
            double size,
            Color color)

Font

public Font(String name,
            double size,
            int style,
            Color color)

Font

public Font(Font other)

方法详细资料

parse

public static Font parse(String fontString)

解析字符串为字体

italic_bold_underline_size_family_color or italic bold underline size family color eq: italic_bold_12_宋体 // 斜体 加粗 12号字 宋体 eq: bold underline 12 'Times New Roman' red // 加粗 12号字 Times New Roman字体 红字

参数:

fontString - italic_bold_underline_size_family_color or italic bold underline size family color

返回:

the Font

抛出:

IllegalArgumentException - if convert failed.

getSize

public int getSize()

获取去尾数后的字体大小10.5实际返回10

返回:

去尾数的字体大小

getSize2

public double getSize2()

获取字体大小

返回:

字体大小

setSize

public Font setSize(int size)

设置字体大小

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

size - 字体大小

返回:

当前字体

setSize

public Font setSize(double size)

设置字体大小

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

size - 字体大小

返回:

当前字体

getName

public String getName()

获取字体名

返回:

字体名

setName

public Font setName(String name)

设置字体名

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

name - 字体名

返回:

当前字体

getFamily

public int getFamily()

获取字体家族

返回:

family取值范围0-255

setFamily

public Font setFamily(int family)

设置字体家族

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

family - 取值范围0-255

返回:

当前字体

getColor

public Color getColor()

获取字体颜色，未主动设置时返回null，输出到xml时显示黑色

返回:

字体颜色

setColor

public Font setColor(Color color)

设置字体颜色

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

color - 字体颜色

返回:

当前字体

getStyle

public int getStyle()

获取字体样式，样式定义在Font.Style类中，建议直接调用专用方法isBold(), isUnderline(), isStrikeThru()和isItalic()方法， 它们直接返回boolean类型的值方便后续判断

返回:

Font.Style定义的样式

setStyle

public Font setStyle(int style)

设置字体样式，样式定义在Font.Style类中，建议直接调用专用方法bold(), underline(), strikeThru()和italic()方法设置， 这几个方法可以组合调用最终效果为组合效果

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

style - Font.Style定义的样式

返回:

当前字体

getScheme

public String getScheme()

获取此字体所属的字体方案，有三种可能的取值"none","major"和"minor"

返回:

字体方案

setScheme

public Font setScheme(String scheme)

设置此字体所属的字体方案，有三种可能的取值"none","major"和"minor"

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

scheme - "none","major"和"minor"三种取值之一

返回:

当前字体

getCharset

public int getCharset()

获取字符集

返回:

字体的字符集参考 Charset

setCharset

public Font setCharset(int charset)

设置字体的字符集

注意：字体是全局共享的所以修改属性前需要先复制字体

参数:

charset - Charset

返回:

当前字体

italic

public Font italic()

添加“斜体”样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

bold

public Font bold()

添加“粗休”样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

underline

public Font underline()

添加“下划线”样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

doubleUnderline

public Font doubleUnderline()

添加“双下划线”样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

strikeThru

public Font strikeThru()

添加“删除线”样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

isItalic

public boolean isItalic()

检查是否有“斜体”样式

返回:

true: 是

isBold

public boolean isBold()

检查是否有“粗体”样式

返回:

true: 是

isUnderline

public boolean isUnderline()

检查是否有“下划线”样式

返回:

true: 是

isStrikeThru

public boolean isStrikeThru()

检查是否有“删除线”样式

返回:

true: 是

isDoubleUnderline

public boolean isDoubleUnderline()

检查是否有“双下划线”样式

返回:

true: 是

delItalic

public Font delItalic()

删除"斜体"样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

delBold

public Font delBold()

删除"加粗"样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

delUnderline

public Font delUnderline()

删除"下划线"样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

delDoubleUnderline

public Font delDoubleUnderline()

删除"下划线"样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

delStrikeThru

public Font delStrikeThru()

删除“删除线”样式

注意：字体是全局共享的所以修改属性前需要先复制字体

返回:

当前字体

toString

public String toString()

覆盖:

toString 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object o)

覆盖:

equals 在类中 Object

toDom

public org.dom4j.Element toDom(org.dom4j.Element root)

输出为dom树

参数:

root - 父节点

返回:

dom树

of

public static Font of(Font awtFont)

将java.awt.Font字体转为当前字体

参数:

awtFont - Font

返回:

a org.ttzero.excel.entity.style.Font

toAwtFont

public Font toAwtFont()

将当前字体转为 Font字体

返回:

java.awt.Font

getFontMetrics

public FontMetrics getFontMetrics()

通过Font获取FontMetrics用以计算文本宽度

返回:

字体度量对象

getFontMetrics

public static FontMetrics getFontMetrics(Font font)

通过Font获取FontMetrics用以计算文本宽度

参数:

font - awt字体

返回:

字体度量对象

domToFont

public static List<Font> domToFont(org.dom4j.Element root,
                                   Color[] indexedColors)

解析字体

参数:

root - styles树root

indexedColors - 特殊indexed颜色（大部分情况下为null）

返回:

styles字体

domToFont

public static List<Font> domToFont(org.dom4j.Element root)

解析字体

参数:

root - styles树root

返回:

styles字体

parseFontTag

public static Font parseFontTag(org.dom4j.Element tag)

解析xml内容创建字体

参数:

tag - dom树font节点

返回:

字体

clone

public Font clone()

覆盖:

clone 在类中 Object

round10

public static int round10(double v)