org.ttzero.excel.entity

类 Comments

java.lang.Object

org.ttzero.excel.entity.Comments

所有已实现的接口:

Closeable, AutoCloseable, Storable

@TopNS(prefix="",
       value="comments",
       uri="http://schemas.openxmlformats.org/spreadsheetml/2006/main")
public class Comments
extends Object
implements Storable, Closeable

批注的简单实现

作者:

guanquan.wang at 2020-05-21 16:31

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Comments.C
static class	Comments.Pr
static class	Comments.R

字段概要

字段

限定符和类型	字段和说明
String	author
List<Comments.C>	commentList Comments Cache
protected static Comments.Pr	DEFAULT_PR 默认字体设置，用于在没有明确指定字体时使用
protected static Comments.Pr	DEFAULT_TITLE_PR 默认标题字体设置，用于在没有明确指定字体时使用
int	id

构造器概要

构造器

构造器和说明
Comments(int id)
Comments(int id, String author)

方法概要

限定符和类型	方法和说明
Comments.C	addComment(int row, int col, Comment comment) 在指定单元格添加批注
Comments.C	addComment(int row, int col, String value) 在指定行列添加批注
Comments.C	addComment(int row, int col, String title, String value) 在指定单元格添加批注
Comments.C	addComment(String ref, Comment comment) 添加评论到指定的单元格位置
Comments.C	addComment(String ref, String title, String value) 添加评论到指定的单元格位置
void	close()
protected Comments.R	toR(String val, boolean isTitle, Font font)
protected void	vml(Path root)
void	writeTo(Path root) 写入指定路径，传入的参数可以是一个文件也可以是文件夹，需要在实现类具体处理

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

commentList

public List<Comments.C> commentList

Comments Cache

id

public int id

author

public String author

DEFAULT_PR

protected static final Comments.Pr DEFAULT_PR

默认字体设置，用于在没有明确指定字体时使用

DEFAULT_TITLE_PR

protected static final Comments.Pr DEFAULT_TITLE_PR

默认标题字体设置，用于在没有明确指定字体时使用

构造器详细资料

Comments

public Comments(int id)

Comments

public Comments(int id,
                String author)

方法详细资料

addComment

public Comments.C addComment(String ref,
                             String title,
                             String value)

添加评论到指定的单元格位置

参数:

ref - 单元格位置索引

title - 评论的标题

value - 评论的内容

返回:

包含新添加批注的对象

addComment

public Comments.C addComment(String ref,
                             Comment comment)

添加评论到指定的单元格位置

参数:

ref - 单元格位置索引

comment - 批注对象

返回:

包含新添加批注的对象

addComment

public Comments.C addComment(int row,
                             int col,
                             String value)

在指定行列添加批注

参数:

row - 行号，从1开始

col - 列号，从1开始

value - 批注内容

返回:

包含新添加批注的对象

addComment

public Comments.C addComment(int row,
                             int col,
                             String title,
                             String value)

在指定单元格添加批注

参数:

row - 行号，从1开始

col - 列号，从1开始

title - 批注标题

value - 批注内容

返回:

包含新添加批注的对象

addComment

public Comments.C addComment(int row,
                             int col,
                             Comment comment)

在指定单元格添加批注

参数:

row - 行号，从1开始

col - 列号，从1开始

comment - 批注对象

返回:

包含新添加批注的对象

toR

protected Comments.R toR(String val,
                         boolean isTitle,
                         Font font)

close

public void close()

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

writeTo

public void writeTo(Path root)
             throws IOException

从接口复制的说明: Storable

写入指定路径，传入的参数可以是一个文件也可以是文件夹，需要在实现类具体处理

指定者:

writeTo 在接口中 Storable

参数:

root - 父级文件夹或文件绝对路径

抛出:

IOException - 写失败异常

vml

protected void vml(Path root)
            throws IOException

抛出:

IOException