com.fr.main.impl

类 WorkBookX

java.lang.Object

com.fr.base.frpx.document.base.AbstractDocumentPart

com.fr.main.impl.AbstractWorkBookX

com.fr.main.impl.WorkBookX

所有已实现的接口:

DocumentPart, AttrMark, BaseBook, ParameterHolder, TableDataSource, FineBook, TemplateWorkBook, FitProvider, ScheduleTemplateWorkBookProvider, FCloneable, XMLable, XMLReadable, XMLWriter, ImportJsCssProvider, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<AbstractDocumentPart>

public class WorkBookX
extends AbstractWorkBookX

扩展模板格式。组织和存放各个文档块，提供操作各个文档块的方式。

作者:

vito

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	SUFFIX

从类继承的字段 com.fr.main.impl.AbstractWorkBookX

pack

从接口继承的字段 com.fr.data.TableDataSource

KEY

从接口继承的字段 com.fr.stable.xml.XMLable

XML_TAG

从接口继承的字段 com.fr.web.ImportJsCssProvider

XML_TAG

构造器概要

构造器

构造器和说明
WorkBookX()
WorkBookX(AbstractFRPackage pack) 通过包构造模板
WorkBookX(java.io.File file) 通过文件构造模板
WorkBookX(java.io.InputStream is) 通过流构造模板
WorkBookX(TemplateReport report) 使用传入的报表构造模板，设计器常用

方法概要

方法

限定符和类型	方法和说明
void	addDocumentPart(AbstractDocumentPart part) 添加文档块
java.lang.String	addPicture(byte[] pictureData, java.lang.String suffix) 添加一张图片到模板。
java.lang.String	addPicture(java.awt.Image im, java.lang.String suffix) 添加一个图片到模板。
java.lang.String	addPicture(java.io.InputStream is, java.lang.String suffix) 添加一个图片到模板。
RawDataPart	addRawData(byte[] bytes) 添加为裸数据块
void	apply4Parameters(java.util.Map parameterMap) 处理参数值
WorkBookX	clone()
ResultWorkBook	execute(java.util.Map parameterMap, Actor actor) 根据给定的参数集和预览方式执行后获取结果报表簿
ResultWorkBook	execute(java.util.Map parameterMap, Actor actor, int sheetIndex) 根据给定的参数集和预览方式执行后获取结果报表簿
void	gcData(java.util.Map<java.lang.String,java.lang.Integer> summaryCheck)
java.util.Iterator<java.lang.String>	getAllMarkName() 获取所有的AttrMark名字迭代器
AttributeDocPart	getAttributeDocPart() 获取属性部分
BaseDocPart	getBaseDocPart() 获取基础部分
ExtraDocPart	getExtraDocPart() 获取模板附加属性部分
ParameterDocPart	getParameterDocPart() 获取模板属性部分
Parameter[]	getParameters() 获取参数持有者持有的参数
PictureDocPart	getPicture(java.lang.String uri) 根据uri获取图片
PictureCollection	getPictureCollection() 获取图片容器
RawDataPart	getRawDataPart(java.lang.String uri) 根据uri获取数据块
ReportDocPart	getReportDocPart() 获取报表部分
StyleDocPart	getStyleDocPart() 获取样式部分
TableDataSourcePart	getTableDataSourcePart() 获取数据源部分
void	load() 加载文档块
static void	main(java.lang.String[] args)
protected static AbstractFRPackage	newPackage()
void	prepareWrite() 写文件前准备
void	removePicture(java.lang.String uri) 移除一张图片
void	removeRawData(java.lang.String uri) 移除一个裸数据块
java.lang.String	suffix() book文件后缀

从类继承的方法 com.fr.main.impl.AbstractWorkBookX

addAttrMark, addReport, addReport, addReport, addReport, clearAllTableData, export, getAttrMark, getCSSImport, getDesignerVersion, getElementCaseReport, getJSImport, getPackage, getPreviewType, getReport, getReportCount, getReportExportAttr, getReportFitAttr, getReportIndex, getReportMobileAttr, getReportName, getReportParameterAttr, getReportWebAttr, getTableData, getTableDataNameIterator, getTemplateElementCaseReport, getTemplateID, getTemplateReport, getXMLDesignerVersion, getXmlVersion, isElementCaseBook, isElementCaseBook, putTableData, readXML, removeReport, removeReport, removeReports, removeTableData, renameTableData, setDesignerVersion, setPreviewType, setReport, setReport, setReportExportAttr, setReportFitAttr, setReportMobileAttr, setReportName, setReportParameterAttr, setReportWebAttr, setTemplateID, setXmlVersion, write, writeXML

从类继承的方法 com.fr.base.frpx.document.base.AbstractDocumentPart

commit, compareTo, createDocPart, createDocPart, createDocPart, destroy, getContainer, getPackagePart, getParent, getPriority, getTag, loadDelay, onCommit, onRead, onReadDelay, save, setContainer, setPackagePart, setParent

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

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

字段详细资料

SUFFIX

public static final java.lang.String SUFFIX

另请参阅:

常量字段值

构造器详细资料

WorkBookX

public WorkBookX()

WorkBookX

public WorkBookX(TemplateReport report)

使用传入的报表构造模板，设计器常用

参数:

report - 报表

WorkBookX

public WorkBookX(java.io.InputStream is)
          throws java.io.IOException

通过流构造模板

参数:

is - 流

抛出:

java.io.IOException - 读取失败

WorkBookX

public WorkBookX(java.io.File file)

通过文件构造模板

参数:

file - 文件

WorkBookX

public WorkBookX(AbstractFRPackage pack)

通过包构造模板

参数:

pack - 抽象宝模型

方法详细资料

addDocumentPart

public void addDocumentPart(AbstractDocumentPart part)

添加文档块

参数:

part - 文档块

getBaseDocPart

@Nonnull
public BaseDocPart getBaseDocPart()

从类复制的说明: AbstractWorkBookX

获取基础部分

指定者:

getBaseDocPart 在类中 AbstractWorkBookX

返回:

返回基础部分

getAttributeDocPart

@Nonnull
public AttributeDocPart getAttributeDocPart()

从类复制的说明: AbstractWorkBookX

获取属性部分

指定者:

getAttributeDocPart 在类中 AbstractWorkBookX

返回:

返回报表属性部分

getExtraDocPart

@Nonnull
public ExtraDocPart getExtraDocPart()

从类复制的说明: AbstractWorkBookX

获取模板附加属性部分

指定者:

getExtraDocPart 在类中 AbstractWorkBookX

返回:

返回附加部分

getParameterDocPart

@Nonnull
public ParameterDocPart getParameterDocPart()

从类复制的说明: AbstractWorkBookX

获取模板属性部分

指定者:

getParameterDocPart 在类中 AbstractWorkBookX

返回:

返回附加部分

getTableDataSourcePart

@Nonnull
public TableDataSourcePart getTableDataSourcePart()

从类复制的说明: AbstractWorkBookX

获取数据源部分

指定者:

getTableDataSourcePart 在类中 AbstractWorkBookX

返回:

返回数据源部分

getReportDocPart

@Nonnull
public ReportDocPart getReportDocPart()

从类复制的说明: AbstractWorkBookX

获取报表部分

指定者:

getReportDocPart 在类中 AbstractWorkBookX

返回:

返回报表部分

getStyleDocPart

@Nonnull
public StyleDocPart getStyleDocPart()

从类复制的说明: AbstractWorkBookX

获取样式部分

指定者:

getStyleDocPart 在类中 AbstractWorkBookX

返回:

返回样式部分

load

public void load()

从类复制的说明: AbstractDocumentPart

加载文档块

指定者:

load 在接口中 DocumentPart

覆盖:

load 在类中 AbstractDocumentPart

newPackage

protected static AbstractFRPackage newPackage()

prepareWrite

public void prepareWrite()
                  throws java.io.IOException

写文件前准备

指定者:

prepareWrite 在类中 AbstractWorkBookX

抛出:

java.io.IOException - 保存失败

getPicture

@Nonnull
public PictureDocPart getPicture(java.lang.String uri)

根据uri获取图片

指定者:

getPicture 在类中 AbstractWorkBookX

参数:

uri - 块 uri

返回:

图片块

getPictureCollection

@Nullable
public PictureCollection getPictureCollection()

获取图片容器

指定者:

getPictureCollection 在类中 AbstractWorkBookX

返回:

图片容器

addPicture

public java.lang.String addPicture(byte[] pictureData,
                          java.lang.String suffix)
                            throws java.io.IOException

从类复制的说明: AbstractWorkBookX

添加一张图片到模板。若传入的字节数组为图片文件的字节数组， 则保存图片的时候不会有损失。

指定者:

addPicture 在类中 AbstractWorkBookX

参数:

pictureData - 图片的 bytes 数据

suffix - 图片格式后缀

返回:

图片uri

抛出:

java.io.IOException - 添加失败

另请参阅:

MediaSchemas.IMAGE_JPEG, MediaSchemas.IMAGE_PNG, MediaSchemas.IMAGE_BMP, MediaSchemas.IMAGE_GIF, AbstractWorkBookX.getPictureCollection()

addPicture

public java.lang.String addPicture(java.io.InputStream is,
                          java.lang.String suffix)
                            throws java.io.IOException

从类复制的说明: AbstractWorkBookX

添加一个图片到模板。若传入的流为图片的文件流， 则保存图片的时候不会有损失。

指定者:

addPicture 在类中 AbstractWorkBookX

参数:

is - 输入流

suffix - 图片格式后缀

返回:

图片uri

抛出:

java.io.IOException - 添加失败

另请参阅:

MediaSchemas.IMAGE_JPEG, MediaSchemas.IMAGE_PNG, MediaSchemas.IMAGE_BMP, MediaSchemas.IMAGE_GIF, AbstractWorkBookX.getPictureCollection()

addPicture

public java.lang.String addPicture(java.awt.Image im,
                          java.lang.String suffix)
                            throws java.io.IOException

从类复制的说明: AbstractWorkBookX

添加一个图片到模板。和上面的不同，使用这个方法添加图片， 在持久化的时候会有损失，原因是写Image对象的问题。优先 使用其他两种添加方式

指定者:

addPicture 在类中 AbstractWorkBookX

参数:

im - 图片对象

suffix - 图片格式后缀

返回:

图片uri

抛出:

java.io.IOException - 添加失败

另请参阅:

MediaSchemas.IMAGE_JPEG, MediaSchemas.IMAGE_PNG, MediaSchemas.IMAGE_BMP, MediaSchemas.IMAGE_GIF, AbstractWorkBookX.getPictureCollection(), AbstractWorkBookX.addPicture(InputStream is, String suffix), AbstractWorkBookX.addPicture(byte[] pictureData, String suffix)

removePicture

public void removePicture(java.lang.String uri)

从类复制的说明: AbstractWorkBookX

移除一张图片

指定者:

removePicture 在类中 AbstractWorkBookX

参数:

uri - 图片uri

getRawDataPart

@Nonnull
public RawDataPart getRawDataPart(java.lang.String uri)

从类复制的说明: AbstractWorkBookX

根据uri获取数据块

指定者:

getRawDataPart 在类中 AbstractWorkBookX

参数:

uri - 块 uri

返回:

uri对应的裸数据块

addRawData

public RawDataPart addRawData(byte[] bytes)
                       throws java.io.IOException

从类复制的说明: AbstractWorkBookX

添加为裸数据块

指定者:

addRawData 在类中 AbstractWorkBookX

参数:

bytes - 数据

返回:

添加后的裸数据块

抛出:

java.io.IOException - 添加异常

removeRawData

public void removeRawData(java.lang.String uri)

从类复制的说明: AbstractWorkBookX

移除一个裸数据块

指定者:

removeRawData 在类中 AbstractWorkBookX

参数:

uri - 块uri

gcData

public void gcData(java.util.Map<java.lang.String,java.lang.Integer> summaryCheck)

suffix

public java.lang.String suffix()

从接口复制的说明: BaseBook

book文件后缀

返回:

后缀的字符串

apply4Parameters

public void apply4Parameters(java.util.Map parameterMap)

处理参数值

参数:

parameterMap - 参数map

execute

public ResultWorkBook execute(java.util.Map parameterMap,
                     Actor actor)

根据给定的参数集和预览方式执行后获取结果报表簿

参数:

parameterMap - 参数集

actor - 预览方式

返回:

结果报表薄

execute

public ResultWorkBook execute(java.util.Map parameterMap,
                     Actor actor,
                     int sheetIndex)

根据给定的参数集和预览方式执行后获取结果报表簿

参数:

parameterMap - 参数集

actor - 预览方式

sheetIndex - 要计算的sheet索引

返回:

结果报表薄

getParameters

public Parameter[] getParameters()

获取参数持有者持有的参数

返回:

参数数组

clone

public WorkBookX clone()

指定者:

clone 在接口中 FCloneable

覆盖:

clone 在类中 AbstractWorkBookX

返回:

克隆后的对象

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

抛出:

java.io.IOException

getAllMarkName

public java.util.Iterator<java.lang.String> getAllMarkName()

从接口复制的说明: AttrMark

获取所有的AttrMark名字迭代器

返回:

AttrMark名字迭代器