XEasyPdfBarCode (x-easypdf-pdfbox 2.12.1 API)

java.lang.Object
- org.dromara.pdf.pdfbox.component.barcode.XEasyPdfBarCode

所有已实现的接口:

Serializable, XEasyPdfComponent
```
public class XEasyPdfBarCode
extends Object
implements XEasyPdfComponent
```
pdf条形码(一维码/二维码)组件

从以下版本开始:

1.8
Copyright (c) 2020-2023 xsx All Rights Reserved. x-easypdf is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

作者:

xsx

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`XEasyPdfBarCode.CodeType` 编码类型
`static class`	`XEasyPdfBarCode.ErrorLevel` 纠错级别
`static class`	`XEasyPdfBarCode.WordsStyle` 文字样式

从接口继承的嵌套类/接口 org.dromara.pdf.pdfbox.component.XEasyPdfComponent
XEasyPdfComponent.ContentMode

构造器概要

构造器
构造器和说明
`XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType, String content)` 有参构造
`XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType, String content, float beginX, float beginY)` 有参构造
`XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType, String content, String words)` 有参构造
`XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType, String content, String words, float beginX, float beginY)` 有参构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`com.google.zxing.common.BitMatrix`	`createBitMatrix()` 创建位矩阵
`void`	`draw(XEasyPdfDocument document, XEasyPdfPage page)` 绘制
`XEasyPdfBarCode`	`enableResetContext()` 开启上下文重置
`XEasyPdfBarCode`	`enableShowWords()` 开启文字显示
`BufferedImage`	`getBarCodeImage(com.google.zxing.common.BitMatrix matrix)` 获取条形码图片
`float`	`getHeight(XEasyPdfDocument document, XEasyPdfPage page)` 获取高度
`void`	`init()` 初始化（公共参数）
`XEasyPdfBarCode`	`setCodeMargin(int codeMargin)` 设置条形码边距
`XEasyPdfBarCode`	`setCodeType(XEasyPdfBarCode.CodeType codeType)` 设置条形码类型
`XEasyPdfBarCode`	`setContent(String content)` 设置条形码内容
`XEasyPdfBarCode`	`setContentMode(XEasyPdfComponent.ContentMode mode)` 设置内容模式
`XEasyPdfBarCode`	`setErrorLevel(XEasyPdfBarCode.ErrorLevel errorLevel)` 设置纠错级别
`XEasyPdfBarCode`	`setHeight(float height)` 设置高度（图像显示宽度）
`XEasyPdfBarCode`	`setMarginBottom(float marginBottom)` 设置下边距
`XEasyPdfBarCode`	`setMarginLeft(float marginLeft)` 设置左边距
`XEasyPdfBarCode`	`setMarginRight(float marginRight)` 设置右边距
`XEasyPdfBarCode`	`setMarginTop(float marginTop)` 设置上边距
`XEasyPdfBarCode`	`setMaxHeight(float height)` 设置最大高度（图像实际高度）
`XEasyPdfBarCode`	`setMaxWidth(float width)` 设置最大宽度（图像实际宽度）
`XEasyPdfBarCode`	`setOffColor(Color offColor)` 设置条形码背景颜色
`XEasyPdfBarCode`	`setOnColor(Color onColor)` 设置条形码前景颜色
`XEasyPdfBarCode`	`setPosition(float beginX, float beginY)` 设置定位
`XEasyPdfBarCode`	`setQrVersion(int version)` 设置二维码版本（仅二维码有效）
`XEasyPdfBarCode`	`setRadians(double radians)` 设置条形码旋转弧度
`XEasyPdfBarCode`	`setWidth(float width)` 设置宽度（图像显示宽度）
`XEasyPdfBarCode`	`setWords(String words)` 设置条形码文字
`XEasyPdfBarCode`	`setWordsColor(Color wordsColor)` 设置条形码文字颜色
`XEasyPdfBarCode`	`setWordsSize(int wordsSize)` 设置条形码文字大小
`XEasyPdfBarCode`	`setWordsStyle(XEasyPdfBarCode.WordsStyle wordsStyle)` 设置条形码文字样式

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

- 构造器详细资料
  - XEasyPdfBarCode
```
public XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType,
                       String content)
```
    有参构造
    
    参数:
    
    codeType - 条形码类型
    
    content - 条形码内容
  - XEasyPdfBarCode
```
public XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType,
                       String content,
                       String words)
```
    有参构造
    
    参数:
    
    codeType - 条形码类型
    
    content - 条形码内容
    
    words - 条形码文字
  - XEasyPdfBarCode
```
public XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType,
                       String content,
                       float beginX,
                       float beginY)
```
    有参构造
    
    参数:
    
    codeType - 条形码类型
    
    content - 条形码内容
    
    beginX - X轴起始坐标
    
    beginY - Y轴起始坐标
  - XEasyPdfBarCode
```
public XEasyPdfBarCode(XEasyPdfBarCode.CodeType codeType,
                       String content,
                       String words,
                       float beginX,
                       float beginY)
```
    有参构造
    
    参数:
    
    codeType - 条形码类型
    
    content - 条形码内容
    
    words - 条形码文字
    
    beginX - X轴起始坐标
    
    beginY - Y轴起始坐标
- 方法详细资料
  - setPosition
```
public XEasyPdfBarCode setPosition(float beginX,
                                   float beginY)
```
    设置定位
    
    指定者:
    
    setPosition 在接口中 XEasyPdfComponent
    
    参数:
    
    beginX - X轴起始坐标
    
    beginY - Y轴起始坐标
    
    返回:
    
    返回条形码组件
  - setWidth
```
public XEasyPdfBarCode setWidth(float width)
```
    设置宽度（图像显示宽度）
    
    指定者:
    
    setWidth 在接口中 XEasyPdfComponent
    
    参数:
    
    width - 宽度
    
    返回:
    
    返回条形码组件
  - setHeight
```
public XEasyPdfBarCode setHeight(float height)
```
    设置高度（图像显示宽度）
    
    指定者:
    
    setHeight 在接口中 XEasyPdfComponent
    
    参数:
    
    height - 高度
    
    返回:
    
    返回条形码组件
  - setMaxWidth
```
public XEasyPdfBarCode setMaxWidth(float width)
```
    设置最大宽度（图像实际宽度）
    
    参数:
    
    width - 宽度
    
    返回:
    
    返回条形码组件
  - setMaxHeight
```
public XEasyPdfBarCode setMaxHeight(float height)
```
    设置最大高度（图像实际高度）
    
    参数:
    
    height - 高度
    
    返回:
    
    返回条形码组件
  - setContentMode
```
public XEasyPdfBarCode setContentMode(XEasyPdfComponent.ContentMode mode)
```
    设置内容模式
    
    指定者:
    
    setContentMode 在接口中 XEasyPdfComponent
    
    参数:
    
    mode - 内容模式
    
    返回:
    
    返回条形码组件
  - setCodeType
```
public XEasyPdfBarCode setCodeType(XEasyPdfBarCode.CodeType codeType)
```
    设置条形码类型
    
    参数:
    
    codeType - 条形码类型
    
    返回:
    
    返回条形码组件
  - setCodeMargin
```
public XEasyPdfBarCode setCodeMargin(int codeMargin)
```
    设置条形码边距
    
    参数:
    
    codeMargin - 条形码边距
    
    返回:
    
    返回条形码组件
  - setErrorLevel
```
public XEasyPdfBarCode setErrorLevel(XEasyPdfBarCode.ErrorLevel errorLevel)
```
    设置纠错级别
    
    参数:
    
    errorLevel - 条形码纠错级别
    
    返回:
    
    返回条形码组件
  - setQrVersion
```
public XEasyPdfBarCode setQrVersion(int version)
```
    设置二维码版本（仅二维码有效）
    
    参数:
    
    version - 二维码版本
    
    返回:
    
    返回条形码组件
  - setContent
```
public XEasyPdfBarCode setContent(String content)
```
    设置条形码内容
    
    参数:
    
    content - 条形码内容
    
    返回:
    
    返回条形码组件
  - setOnColor
```
public XEasyPdfBarCode setOnColor(Color onColor)
```
    设置条形码前景颜色
    
    参数:
    
    onColor - 条形码前景颜色
    
    返回:
    
    返回条形码组件
  - setOffColor
```
public XEasyPdfBarCode setOffColor(Color offColor)
```
    设置条形码背景颜色
    
    参数:
    
    offColor - 条形码背景颜色
    
    返回:
    
    返回条形码组件
  - setWords
```
public XEasyPdfBarCode setWords(String words)
```
    设置条形码文字
    
    参数:
    
    words - 条形码文字
    
    返回:
    
    返回条形码组件
  - setWordsColor
```
public XEasyPdfBarCode setWordsColor(Color wordsColor)
```
    设置条形码文字颜色
    
    参数:
    
    wordsColor - 条形码文字颜色
    
    返回:
    
    返回条形码组件
  - setWordsStyle
```
public XEasyPdfBarCode setWordsStyle(XEasyPdfBarCode.WordsStyle wordsStyle)
```
    设置条形码文字样式
    
    参数:
    
    wordsStyle - 条形码文字样式
    
    返回:
    
    返回条形码组件
  - setWordsSize
```
public XEasyPdfBarCode setWordsSize(int wordsSize)
```
    设置条形码文字大小
    
    参数:
    
    wordsSize - 条形码文字大小
    
    返回:
    
    返回条形码组件
  - setRadians
```
public XEasyPdfBarCode setRadians(double radians)
```
    设置条形码旋转弧度
    
    参数:
    
    radians - 条形码旋转弧度
    
    返回:
    
    返回条形码组件
  - setMarginLeft
```
public XEasyPdfBarCode setMarginLeft(float marginLeft)
```
    设置左边距
    
    参数:
    
    marginLeft - 左边距
    
    返回:
    
    返回条形码组件
  - setMarginRight
```
public XEasyPdfBarCode setMarginRight(float marginRight)
```
    设置右边距
    
    参数:
    
    marginRight - 右边距
    
    返回:
    
    返回条形码组件
  - setMarginTop
```
public XEasyPdfBarCode setMarginTop(float marginTop)
```
    设置上边距
    
    参数:
    
    marginTop - 上边距
    
    返回:
    
    返回条形码组件
  - setMarginBottom
```
public XEasyPdfBarCode setMarginBottom(float marginBottom)
```
    设置下边距
    
    参数:
    
    marginBottom - 下边距
    
    返回:
    
    返回条形码组件
  - enableShowWords
```
public XEasyPdfBarCode enableShowWords()
```
    开启文字显示
    
    返回:
    
    返回条形码组件
  - enableResetContext
```
public XEasyPdfBarCode enableResetContext()
```
    开启上下文重置
    
    指定者:
    
    enableResetContext 在接口中 XEasyPdfComponent
    
    返回:
    
    返回条形码组件
  - draw
```
public void draw(XEasyPdfDocument document,
                 XEasyPdfPage page)
```
    绘制
    
    指定者:
    
    draw 在接口中 XEasyPdfComponent
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
  - init
```
public void init()
```
    初始化（公共参数）
  - createBitMatrix
```
public com.google.zxing.common.BitMatrix createBitMatrix()
```
    创建位矩阵
    
    返回:
    
    返回位矩阵
  - getBarCodeImage
```
public BufferedImage getBarCodeImage(com.google.zxing.common.BitMatrix matrix)
```
    获取条形码图片
    
    参数:
    
    matrix - 位矩阵
    
    返回:
    
    返回条形码图片
  - getHeight
```
public float getHeight(XEasyPdfDocument document,
                       XEasyPdfPage page)
```
    获取高度
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
    
    返回:
    
    返回高度

类 XEasyPdfBarCode

嵌套类概要

从接口继承的嵌套类/接口 org.dromara.pdf.pdfbox.component.XEasyPdfComponent

构造器概要

方法概要

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

构造器详细资料

XEasyPdfBarCode

XEasyPdfBarCode

XEasyPdfBarCode

XEasyPdfBarCode

方法详细资料

setPosition

setWidth

setHeight

setMaxWidth

setMaxHeight

setContentMode

setCodeType

setCodeMargin

setErrorLevel

setQrVersion

setContent

setOnColor

setOffColor

setWords

setWordsColor

setWordsStyle

setWordsSize

setRadians

setMarginLeft

setMarginRight

setMarginTop

setMarginBottom

enableShowWords

enableResetContext

draw

init

createBitMatrix

getBarCodeImage

getHeight