ArtWord (ofdrw-layout 2.3.4 API)

java.lang.Object
- org.ofdrw.layout.element.Div<Canvas>
- - org.ofdrw.layout.element.canvas.Canvas
  - - org.ofdrw.layout.element.canvas.CanvasBase
    - - org.ofdrw.layout.element.canvas.ArtWord

所有已实现的接口:

Drawer, ElementSplit, RenderPrepare
```
public class ArtWord
extends CanvasBase
```
艺术字元素本元素在Span元素的效果上增加了艺术字常见效果，，比如斜体，文字左右拉伸，文字垂直拉伸

从以下版本开始:

2024/6/12

作者:

韩兴元

构造器概要

构造器
构造器和说明

ArtWord(Double width, Double height)

构造器
构造器和说明
`ArtWord(Double width, Double height)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ArtWord`	`clone()` 克隆Div
`void`	`draw(DrawContext ctx)` 绘制
`int[]`	`getColor()`
`Font`	`getFont()`
`Double`	`getFontSize()`
`double`	`getHorizontalInclination()`
`double`	`getHorizontalScaling()`
`Double`	`getLetterSpacing()`
`double`	`getOffsetX()`
`double`	`getOffsetY()`
`String`	`getText()`
`TextAlign`	`getTextAlign()`
`TextAlign`	`getTextLayoutAlign()`
`double`	`getUnderlineOffset()` 获取下划线与文字的偏移量
`double`	`getUnderlineWidth()` 获取下划线宽度
`double`	`getVerticalInclination()`
`double`	`getVerticalScaling()`
`org.ofdrw.core.text.text.Weight`	`getWeight()` 获取字体粗细
`boolean`	`isBold()`
`boolean`	`isItalic()`
`boolean`	`isUnderline()`
`int`	`length()`
`ArtWord`	`setBold(boolean bold)` 设置是否加粗若需要更加细致的控制，可以使用 `setWeight(Weight)`
`ArtWord`	`setColor(int[] rgb)` 设置字体颜色
`ArtWord`	`setColor(int r, int g, int b)` 设置字体颜色
`ArtWord`	`setColor(String color)` 设置字体颜色
`ArtWord`	`setFont(Font font)`
`ArtWord`	`setFontSize(Double fontSize)`
`void`	`setHorizontalInclination(double horizontalInclination)`
`void`	`setHorizontalScaling(double horizontalScaling)`
`ArtWord`	`setItalic(boolean italic)`
`ArtWord`	`setLetterSpacing(Double letterSpacing)`
`void`	`setOffsetX(double offsetX)`
`void`	`setOffsetY(double offsetY)`
`ArtWord`	`setText(String text)`
`void`	`setTextAlign(TextAlign textAlign)`
`void`	`setTextLayoutAlign(TextAlign textLayoutAlign)`
`ArtWord`	`setUnderline(boolean underline)` 设置下划线
`ArtWord`	`setUnderline(boolean underline, double offset, double width)` 设置下划线
`void`	`setVerticalInclination(double verticalInclination)`
`void`	`setVerticalScaling(double verticalScaling)`
`ArtWord`	`setWeight(org.ofdrw.core.text.text.Weight weight)` 设置字体粗细

从类继承的方法 org.ofdrw.layout.element.canvas.Canvas
doPrepare, elementType, getDrawer, getPreferBlock, setDrawer, setPreferBlock

从类继承的方法 org.ofdrw.layout.element.Div
box, contentSplitAdjust, copyTo, getBackgroundColor, getBorder, getBorderBottom, getBorderColor, getBorderDash, getBorderLeft, getBorderRight, getBorderTop, getClear, getDisplay, getFloat, getHeight, getLayer, getLeft, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOnRenderFinish, getOpacity, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTop, getWidth, getX, getY, heightPlus, isBlockElement, isIntegrity, isNoBorder, isPlaceholder, onRenderFinish, placeholder, placeholder, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorder, setBorderBottom, setBorderColor, setBorderColor, setBorderColor, setBorderDash, setBorderLeft, setBorderRight, setBorderTop, setBox, setClear, setDisplay, setFloat, setHeight, setIntegrity, setLayer, setLeft, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setOpacity, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPlaceholder, setPosition, setRight, setTop, setWidth, setX, setXY, setY, split, toString, widthPlus

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

构造器详细资料

ArtWord

public ArtWord(Double width,
               Double height)

方法详细资料

getColor
```
public int[] getColor()
```

setColor
```
public ArtWord setColor(int[] rgb)
```
设置字体颜色

参数:

rgb - 颜色值

返回:

this

setColor

public ArtWord setColor(int r,
                        int g,
                        int b)

设置字体颜色

参数:: r - 红; g - 绿; b - 懒
返回:: this

setColor
```
public ArtWord setColor(String color)
```
设置字体颜色

参数:

color - 16进制颜色，如#FFFFFF

返回:

this

length
```
public int length()
```
返回:

字符数量

getFont
```
public Font getFont()
```

setFont
```
public ArtWord setFont(Font font)
```

getFontSize
```
public Double getFontSize()
```

setFontSize

public ArtWord setFontSize(Double fontSize)

getLetterSpacing
```
public Double getLetterSpacing()
```

setLetterSpacing

public ArtWord setLetterSpacing(Double letterSpacing)

isBold
```
public boolean isBold()
```

setBold
```
public ArtWord setBold(boolean bold)
```
设置是否加粗
若需要更加细致的控制，可以使用 setWeight(Weight)

参数:

bold - 是否加粗

返回:

this

getWeight
```
public org.ofdrw.core.text.text.Weight getWeight()
```
获取字体粗细

返回:

字体粗细，可能为null。

setWeight

public ArtWord setWeight(org.ofdrw.core.text.text.Weight weight)

设置字体粗细

参数:: weight - 字体粗细
返回:: this

isItalic
```
public boolean isItalic()
```

setItalic

public ArtWord setItalic(boolean italic)

isUnderline
```
public boolean isUnderline()
```

setUnderline
```
public ArtWord setUnderline(boolean underline)
```
设置下划线

参数:

underline - 是否启用下划线

返回:

this

setUnderline
```
public ArtWord setUnderline(boolean underline,
                            double offset,
                            double width)
```
设置下划线

参数:

underline - 是否启用下划线

offset - 下划线与文字的偏移量，可以为负值，默认值为1.2，单位毫米。

width - 下划线线宽，默认为0，为0时默认为字体大小的0.05倍。

返回:

this

getText
```
public String getText()
```

setText
```
public ArtWord setText(String text)
```

getOffsetY
```
public double getOffsetY()
```

setOffsetY

public void setOffsetY(double offsetY)

getOffsetX
```
public double getOffsetX()
```

setOffsetX

public void setOffsetX(double offsetX)

getVerticalInclination

public double getVerticalInclination()

setVerticalInclination

public void setVerticalInclination(double verticalInclination)

getHorizontalInclination

public double getHorizontalInclination()

setHorizontalInclination

public void setHorizontalInclination(double horizontalInclination)

getVerticalScaling
```
public double getVerticalScaling()
```

setVerticalScaling

public void setVerticalScaling(double verticalScaling)

getHorizontalScaling
```
public double getHorizontalScaling()
```

setHorizontalScaling

public void setHorizontalScaling(double horizontalScaling)

getTextAlign
```
public TextAlign getTextAlign()
```

setTextAlign

public void setTextAlign(TextAlign textAlign)

getUnderlineOffset
```
public double getUnderlineOffset()
```
获取下划线与文字的偏移量

返回:

下划线与文字的偏移量，单位毫米

getUnderlineWidth
```
public double getUnderlineWidth()
```
获取下划线宽度

返回:

下划线宽度, 0表示保持默认，默认为字体大小的0.05倍，单位毫米

getTextLayoutAlign
```
public TextAlign getTextLayoutAlign()
```

setTextLayoutAlign

public void setTextLayoutAlign(TextAlign textLayoutAlign)

clone
```
public ArtWord clone()
```
从类复制的说明: Div

克隆Div

覆盖:

clone 在类中 Div<Canvas>

返回:

一模一样的全新Div对象

draw
```
public void draw(DrawContext ctx)
          throws IOException
```
从接口复制的说明: Drawer

绘制

参数:

ctx - 绘制上下文

抛出:

IOException - 图片读取过程中IO异常

类 ArtWord

构造器概要

方法概要

从类继承的方法 org.ofdrw.layout.element.canvas.Canvas

从类继承的方法 org.ofdrw.layout.element.Div

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

构造器详细资料

ArtWord

方法详细资料

getColor

setColor

setColor

setColor

length

getFont

setFont

getFontSize

setFontSize

getLetterSpacing

setLetterSpacing

isBold

setBold

getWeight

setWeight

isItalic

setItalic

isUnderline

setUnderline

setUnderline

getText

setText

getOffsetY

setOffsetY

getOffsetX

setOffsetX

getVerticalInclination

setVerticalInclination

getHorizontalInclination

setHorizontalInclination

getVerticalScaling

setVerticalScaling

getHorizontalScaling

setHorizontalScaling

getTextAlign

setTextAlign

getUnderlineOffset

getUnderlineWidth

getTextLayoutAlign

setTextLayoutAlign

clone

draw