AbstractCaptcha (allbs-captcha 1.1.4 API)

java.lang.Object
- cn.allbs.captcha.core.AbstractCaptcha

所有已实现的接口:

ICaptcha

直接已知子类:

CharCaptcha, ChineseCaptcha, LowerCharCaptcha, NumberCaptcha, NumberCharMixtureCaptcha, NumberCountCaptcha, UpperCharCaptcha
```
public abstract class AbstractCaptcha
extends Object
implements ICaptcha
```
作者:

ChenQi

字段概要

字段
限定符和类型	字段和说明
`protected Color`	`background` 背景色
`protected String`	`code` 验证码
`protected char[]`	`codeChar` code
`protected Color`	`color` 文字颜色
`protected Font`	`font` 字体
`protected CaptchaGenerator`	`generator` 验证码生成器
`protected int`	`height` 图片的高度
`protected byte[]`	`imageBytes` 验证码图片
`protected int`	`imageType` 图片类型
`protected int`	`interfereCount` 验证码干扰元素个数
`protected int`	`len` 字符个数
`protected String`	`mimeType` contentType
`protected AlphaComposite`	`textAlpha` 文字透明度
`protected int`	`width` 图片的宽度

构造器概要

构造器
构造器和说明
`AbstractCaptcha(CaptchaDetails captchaDetails)`
`AbstractCaptcha(CaptchaDetails captchaDetails, CaptchaGenerator generator)`
`AbstractCaptcha(int width, int height, CaptchaGenerator generator, int interfereCount, int len)`
`AbstractCaptcha(int width, int height, CaptchaGenerator generator, int interfereCount, int len, Font font)`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`create()` 创建验证码
`protected abstract Image`	`createImage(char[] code)` 根据生成的code创建验证码图片
`protected abstract void`	`createImageGif(char[] code)` 创建验证码gif图
`protected void`	`generateCode()` 生成验证码
`float`	`getAlpha(int i, int j)` 获取透明度,从0到1,自动计算步长
`float`	`getAlpha(int i, int j, int leng)`
`CaptchaGenerator`	`getGenerator()` 获取验证码生成器
`BufferedImage`	`getImage()` 获取验证码图
`String`	`getImageBase64()` 获得图片的Base64形式
`String`	`getImageBase64Data()` 获取图片带文件格式的 Base64
`byte[]`	`getImageBytes()` 获取图形验证码图片bytes
`String`	`getMimeType()` 获取图片mimeType
`String`	`getText()` 获取验证码内容
`BufferedImage`	`graphicsImage(Color[] fontColor, char[] strs, int flag, int[][] besselXY)` 画随机码图
`static int`	`num(int num)` 产生0-num的随机数,不包括num
`static int`	`num(int min, int max)`
`void`	`setBackground(Color background)` 设置背景色
`void`	`setFont(Font font)` 自定义字体
`void`	`setGenerator(CaptchaGenerator generator)` 设置验证码生成器
`void`	`setTextAlpha(float textAlpha)` 设置文字透明度
`boolean`	`verify(String checkedCode)` 校验验证码是否一致
`void`	`write(File file)` 验证码写出到文件
`void`	`write(OutputStream out)` 输出到指定流中
`void`	`write(String path)` 验证码写出到文件

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

字段详细资料

width
```
protected int width
```
图片的宽度

height
```
protected int height
```
图片的高度

interfereCount
```
protected int interfereCount
```
验证码干扰元素个数

font
```
protected Font font
```
字体

code
```
protected String code
```
验证码

imageBytes
```
protected byte[] imageBytes
```
验证码图片

generator
```
protected CaptchaGenerator generator
```
验证码生成器

background
```
protected Color background
```
背景色

textAlpha
```
protected AlphaComposite textAlpha
```
文字透明度

len
```
protected int len
```
字符个数

color
```
protected Color color
```
文字颜色

codeChar
```
protected char[] codeChar
```
code

imageType
```
protected int imageType
```
图片类型

mimeType
```
protected String mimeType
```
contentType

构造器详细资料

AbstractCaptcha

public AbstractCaptcha(int width,
                       int height,
                       CaptchaGenerator generator,
                       int interfereCount,
                       int len)

AbstractCaptcha

public AbstractCaptcha(int width,
                       int height,
                       CaptchaGenerator generator,
                       int interfereCount,
                       int len,
                       Font font)

AbstractCaptcha

public AbstractCaptcha(CaptchaDetails captchaDetails)

AbstractCaptcha

public AbstractCaptcha(CaptchaDetails captchaDetails,
                       CaptchaGenerator generator)

方法详细资料
- create
```
public void create()
```
  从接口复制的说明: ICaptcha
  
  创建验证码
  
  指定者:
  
  create 在接口中 ICaptcha
- getText
```
public String getText()
```
  从接口复制的说明: ICaptcha
  
  获取验证码内容
  
  指定者:
  
  getText 在接口中 ICaptcha
  
  返回:
  
  验证码内容
- verify
```
public boolean verify(String checkedCode)
```
  从接口复制的说明: ICaptcha
  
  校验验证码是否一致
  
  指定者:
  
  verify 在接口中 ICaptcha
  
  参数:
  
  checkedCode - 待校验验证码
  
  返回:
  
  true 一致
- write
```
public void write(OutputStream out)
```
  从接口复制的说明: ICaptcha
  
  输出到指定流中
  
  指定者:
  
  write 在接口中 ICaptcha
  
  参数:
  
  out - 流
- write
```
public void write(String path)
           throws cn.hutool.core.io.IORuntimeException
```
  验证码写出到文件
  
  参数:
  
  path - 文件路径
  
  抛出:
  
  cn.hutool.core.io.IORuntimeException - IO异常
- write
```
public void write(File file)
           throws cn.hutool.core.io.IORuntimeException
```
  验证码写出到文件
  
  参数:
  
  file - 文件
  
  抛出:
  
  cn.hutool.core.io.IORuntimeException - IO异常
- generateCode
```
protected void generateCode()
```
  生成验证码
  
  从以下版本开始:
  
  3.3.0
- createImage
```
protected abstract Image createImage(char[] code)
```
  根据生成的code创建验证码图片
  
  参数:
  
  code - 验证码
  
  返回:
  
  Image
- createImageGif
```
protected abstract void createImageGif(char[] code)
```
  创建验证码gif图
  
  参数:
  
  code - 验证码
- getImageBytes
```
public byte[] getImageBytes()
```
  获取图形验证码图片bytes
  
  返回:
  
  图形验证码图片bytes
  
  从以下版本开始:
  
  4.5.17
- getImage
```
public BufferedImage getImage()
```
  获取验证码图
  
  返回:
  
  验证码图
- getImageBase64
```
public String getImageBase64()
```
  获得图片的Base64形式
  
  返回:
  
  图片的Base64
  
  从以下版本开始:
  
  3.3.0
- getImageBase64Data
```
public String getImageBase64Data()
```
  获取图片带文件格式的 Base64
  
  返回:
  
  图片带文件格式的 Base64
  
  从以下版本开始:
  
  5.3.11
- getMimeType
```
public String getMimeType()
```
  获取图片mimeType
  
  返回:
  
  图片mimeType
- setFont
```
public void setFont(Font font)
```
  自定义字体
  
  参数:
  
  font - 字体
- getGenerator
```
public CaptchaGenerator getGenerator()
```
  获取验证码生成器
  
  返回:
  
  验证码生成器
- setGenerator
```
public void setGenerator(CaptchaGenerator generator)
```
  设置验证码生成器
  
  参数:
  
  generator - 验证码生成器
- setBackground
```
public void setBackground(Color background)
```
  设置背景色
  
  参数:
  
  background - 背景色
  
  从以下版本开始:
  
  4.1.22
- setTextAlpha
```
public void setTextAlpha(float textAlpha)
```
  设置文字透明度
  
  参数:
  
  textAlpha - 文字透明度，取值0~1，1表示不透明
  
  从以下版本开始:
  
  4.5.17
- graphicsImage
```
public BufferedImage graphicsImage(Color[] fontColor,
                                   char[] strs,
                                   int flag,
                                   int[][] besselXY)
```
  画随机码图
  
  参数:
  
  fontColor - 随机字体颜色
  
  strs - 字符数组
  
  flag - 透明度
  
  besselXY - 干扰线参数
  
  返回:
  
  BufferedImage
- getAlpha
```
public float getAlpha(int i,
                      int j)
```
  获取透明度,从0到1,自动计算步长
  
  参数:
  
  i -
  
  j -
  
  返回:
  
  透明度
- getAlpha
```
public float getAlpha(int i,
                      int j,
                      int leng)
```
- num
```
public static int num(int min,
                      int max)
```
- num
```
public static int num(int num)
```
  产生0-num的随机数,不包括num
  
  参数:
  
  num - 最大值
  
  返回:
  
  随机数

类 AbstractCaptcha

字段概要

构造器概要

方法概要

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

字段详细资料

width

height

interfereCount

font

code

imageBytes

generator

background

textAlpha

len

color

codeChar

imageType

mimeType

构造器详细资料

AbstractCaptcha

AbstractCaptcha

AbstractCaptcha

AbstractCaptcha

方法详细资料

create

getText

verify

write

write

write

generateCode

createImage

createImageGif

getImageBytes

getImage

getImageBase64

getImageBase64Data

getMimeType

setFont

getGenerator

setGenerator

setBackground

setTextAlpha

graphicsImage

getAlpha

getAlpha

num

num