public abstract class AbstractWorkBookX extends AbstractDocumentPart implements TemplateWorkBook, BaseBook
限定符和类型 | 字段和说明 |
---|---|
protected AbstractFRPackage |
pack |
KEY
XML_TAG
构造器和说明 |
---|
AbstractWorkBookX() |
AbstractWorkBookX(AbstractFRPackage pack) |
限定符和类型 | 方法和说明 |
---|---|
void |
addAttrMark(IOFileAttrMark attrMark)
给模板对象添加额外的属性
|
abstract java.lang.String |
addPicture(byte[] pictureData,
java.lang.String suffix)
添加一张图片到模板。
|
abstract java.lang.String |
addPicture(java.awt.Image im,
java.lang.String suffix)
添加一个图片到模板。
|
abstract java.lang.String |
addPicture(java.io.InputStream is,
java.lang.String suffix)
添加一个图片到模板。
|
abstract RawDataPart |
addRawData(byte[] bytes)
添加为裸数据块
|
void |
addReport(int index,
java.lang.String reportName,
Report report)
添加结果报表
|
void |
addReport(java.lang.String reportName,
Report report)
增加一个指定名称的Report
|
void |
addReport(java.lang.String reportName,
TemplateReport report)
增加一个指定名称的Report
|
void |
addReport(TemplateReport report)
增加一个Report
|
void |
clearAllTableData()
清除所有的数据集
|
AbstractWorkBookX |
clone() |
boolean |
export(java.io.OutputStream out)
导出
|
abstract AttributeDocPart |
getAttributeDocPart()
获取属性部分
|
<T extends IOFileAttrMark> |
getAttrMark(java.lang.String tagName)
根据标签获取模板对象的属性对象
|
abstract BaseDocPart |
getBaseDocPart()
获取基础部分
|
java.lang.String[] |
getCSSImport()
获取引用的css
|
java.lang.String |
getDesignerVersion()
获取设计器版本,用于判断兼容性
|
ECReport |
getElementCaseReport(int index)
当isElementCaseBook返回true时,即该FineBook中包含的都是ECReport时
调用此方法来获取相应位置上的ECReport
非此情况下调用,将抛出RuntimeException
|
abstract ExtraDocPart |
getExtraDocPart()
获取模板附加属性部分
|
java.lang.String[] |
getJSImport()
获取引用的js
|
AbstractFRPackage |
getPackage() |
abstract ParameterDocPart |
getParameterDocPart()
获取模板属性部分
|
abstract PictureDocPart |
getPicture(java.lang.String uri)
根据块 uri 获取图片块
|
abstract PictureCollection |
getPictureCollection()
获取所有的图片
|
int |
getPreviewType()
获取预览方式
|
abstract RawDataPart |
getRawDataPart(java.lang.String uri)
根据uri获取数据块
|
Report |
getReport(int index) |
int |
getReportCount()
获取WorkBook中的Report总数
|
abstract ReportDocPart |
getReportDocPart()
获取报表部分
|
ReportExportAttr |
getReportExportAttr()
Gets report export attributes.
|
ReportFitAttr |
getReportFitAttr() |
int |
getReportIndex(TemplateReport report)
获取给定report的index
|
ElementCaseMobileAttr |
getReportMobileAttr() |
java.lang.String |
getReportName(int index)
获取指定index的Report的Name
|
ReportParameterAttr |
getReportParameterAttr()
获取参数属性
|
ReportWebAttr |
getReportWebAttr()
Gets report web attributes.
|
abstract StyleDocPart |
getStyleDocPart()
获取样式部分
|
TableData |
getTableData(java.lang.String name)
返回该对象中指定名字的数据集
|
java.util.Iterator<java.lang.String> |
getTableDataNameIterator()
返回该对象所包含的所有数据集名的一个迭代
|
abstract TableDataSourcePart |
getTableDataSourcePart()
获取数据源部分
|
WorkSheet |
getTemplateElementCaseReport(int index)
当isElementCaseBook返回true时,即该FineBook中包含的都是ECReport时
调用此方法来获取相应位置上的TemplateECReport
使用同getECReport(int)
非此情况下调用,将抛出RuntimeException
|
java.lang.String |
getTemplateID()
获取模板唯一ID(UUID)
|
TemplateReport |
getTemplateReport(int index)
获取指定位置的TemplateReport
|
java.lang.String |
getXMLDesignerVersion()
已过时。
|
XMLVersion |
getXmlVersion()
获取 XML 版本
|
boolean |
isElementCaseBook()
这个FineBook中包含的Report是否都是ECReport
|
boolean |
isElementCaseBook(int index)
这个FineBook中包含的第index个Report是否是ECReport
|
abstract void |
prepareWrite()
写文件前准备
|
void |
putTableData(java.lang.String name,
TableData innerTableData)
放置指定的数据集到对象中
|
void |
readXML(XMLableReader reader)
读取子节点,应该会被XMLableReader.readXMLObject()调用多次
|
abstract void |
removePicture(java.lang.String uri)
移除一张图片
|
abstract void |
removeRawData(java.lang.String uri)
移除一个裸数据块
|
void |
removeReport(int index)
根据index来移除相应的Report
|
void |
removeReport(java.lang.String reportName)
根据Name来移除相应的Report
|
void |
removeReports()
移除所有的Report
|
void |
removeTableData(java.lang.String name)
移除指定名字的数据集
|
boolean |
renameTableData(java.lang.String oldName,
java.lang.String newName)
重命名指定名字的数据集
|
void |
setDesignerVersion(java.lang.String designerVersion)
设置设计器版本
|
void |
setPreviewType(int previewType)
设置预览方式
|
void |
setReport(int index,
java.lang.String reportName,
TemplateReport report)
设置指定位置的带Name的Report
|
void |
setReport(int index,
TemplateReport report)
设置指定位置的Report
|
void |
setReportExportAttr(ReportExportAttr reportExportAttr)
Sets report export attributes.
|
void |
setReportFitAttr(ReportFitAttr fitAttr) |
void |
setReportMobileAttr(ElementCaseMobileAttr attr) |
void |
setReportName(int index,
java.lang.String reportName)
设置指定index的Report的Name
|
void |
setReportParameterAttr(ReportParameterAttr reportParameterAttr)
设置参数属性
|
void |
setReportWebAttr(ReportWebAttr reportWebAttr)
Sets report web attributes.
|
void |
setTemplateID(java.lang.String templateID)
设置模板的唯一UUID(UUID)
|
void |
setXmlVersion(XMLVersion xmlVersion)
设置 XML 版本
|
void |
write(java.io.OutputStream stream)
将 WorkBookX 写到输出流
|
void |
writeXML(XMLPrintWriter writer)
Write XML.
|
commit, compareTo, createDocPart, createDocPart, createDocPart, destroy, getContainer, getPackagePart, getParent, getPriority, getTag, load, loadDelay, onCommit, onRead, onReadDelay, save, setContainer, setPackagePart, setParent
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
apply4Parameters, execute, execute
getAllMarkName
getParameters
protected AbstractFRPackage pack
public AbstractWorkBookX()
public AbstractWorkBookX(AbstractFRPackage pack)
public AbstractFRPackage getPackage()
public XMLVersion getXmlVersion()
BaseBook
getXmlVersion
在接口中 BaseBook
public void setXmlVersion(XMLVersion xmlVersion)
BaseBook
setXmlVersion
在接口中 BaseBook
@Deprecated public java.lang.String getXMLDesignerVersion()
BaseBook
getXMLDesignerVersion
在接口中 BaseBook
public java.lang.String getDesignerVersion()
BaseBook
getDesignerVersion
在接口中 BaseBook
public void setDesignerVersion(java.lang.String designerVersion)
BaseBook
setDesignerVersion
在接口中 BaseBook
designerVersion
- 设计器版本public java.lang.String getTemplateID()
BaseBook
getTemplateID
在接口中 BaseBook
public void setTemplateID(java.lang.String templateID)
BaseBook
setTemplateID
在接口中 BaseBook
templateID
- 模板唯一ID(UUID)public int getPreviewType()
BaseBook
getPreviewType
在接口中 BaseBook
public void setPreviewType(int previewType)
BaseBook
setPreviewType
在接口中 BaseBook
previewType
- 预览方式public void addAttrMark(IOFileAttrMark attrMark)
addAttrMark
在接口中 AttrMark
attrMark
- 额外的属性对象public <T extends IOFileAttrMark> T getAttrMark(java.lang.String tagName)
getAttrMark
在接口中 AttrMark
T
- 对象类型tagName
- 标签名public java.util.Iterator<java.lang.String> getTableDataNameIterator()
getTableDataNameIterator
在接口中 TableDataSource
public TableData getTableData(java.lang.String name)
getTableData
在接口中 TableDataSource
name
- 数据集的名字public void putTableData(java.lang.String name, TableData innerTableData)
putTableData
在接口中 TableDataSource
name
- 数据集的名字innerTableData
- 数据集public boolean renameTableData(java.lang.String oldName, java.lang.String newName)
renameTableData
在接口中 TableDataSource
oldName
- 数据集老的名字newName
- 数据集新的名字public void removeTableData(java.lang.String name)
removeTableData
在接口中 TableDataSource
name
- 要移除的数据集的名字public void clearAllTableData()
clearAllTableData
在接口中 TableDataSource
public void addReport(TemplateReport report)
addReport
在接口中 TemplateWorkBook
report
- 增加的Reportpublic void addReport(java.lang.String reportName, TemplateReport report)
addReport
在接口中 TemplateWorkBook
reportName
- 指定的名称report
- 增加的Reportpublic void addReport(int index, java.lang.String reportName, Report report)
index
- 当前序列reportName
- 报表名report
- 结果报表public void addReport(java.lang.String reportName, Report report)
reportName
- 指定的名称report
- 增加的Reportpublic void setReport(int index, TemplateReport report)
setReport
在接口中 TemplateWorkBook
index
- 指定的indexreport
- 设置过去的reportpublic void setReport(int index, java.lang.String reportName, TemplateReport report)
setReport
在接口中 TemplateWorkBook
index
- 指定位置reportName
- 新增的Report的Namereport
- 新增的reportpublic TemplateReport getTemplateReport(int index)
getTemplateReport
在接口中 TemplateWorkBook
index
- 指定的索引public WorkSheet getTemplateElementCaseReport(int index)
getTemplateElementCaseReport
在接口中 TemplateWorkBook
index
- public int getReportIndex(TemplateReport report)
getReportIndex
在接口中 TemplateWorkBook
report
- 给定的reportpublic java.lang.String getReportName(int index)
getReportName
在接口中 FineBook
index
- 指定的indexpublic void setReportName(int index, java.lang.String reportName)
setReportName
在接口中 FineBook
index
- 指定的indexreportName
- 指定的Namepublic void removeReport(java.lang.String reportName)
removeReport
在接口中 FineBook
reportName
- 指定的reportNamepublic void removeReport(int index)
removeReport
在接口中 FineBook
index
- 指定的indexpublic void removeReports()
removeReports
在接口中 FineBook
public boolean isElementCaseBook()
isElementCaseBook
在接口中 FineBook
public boolean isElementCaseBook(int index)
isElementCaseBook
在接口中 FineBook
index
- 指定的序列public ECReport getElementCaseReport(int index)
非此情况下调用,将抛出RuntimeException
getElementCaseReport
在接口中 FineBook
index
- public int getReportCount()
getReportCount
在接口中 FineBook
public ReportWebAttr getReportWebAttr()
getReportWebAttr
在接口中 FineBook
public void setReportWebAttr(ReportWebAttr reportWebAttr)
setReportWebAttr
在接口中 FineBook
reportWebAttr
- public ReportExportAttr getReportExportAttr()
getReportExportAttr
在接口中 FineBook
public void setReportExportAttr(ReportExportAttr reportExportAttr)
setReportExportAttr
在接口中 FineBook
reportExportAttr
- public ElementCaseMobileAttr getReportMobileAttr()
getReportMobileAttr
在接口中 FineBook
public void setReportMobileAttr(ElementCaseMobileAttr attr)
setReportMobileAttr
在接口中 FineBook
public ReportFitAttr getReportFitAttr()
getReportFitAttr
在接口中 FitProvider
public void setReportFitAttr(ReportFitAttr fitAttr)
setReportFitAttr
在接口中 FitProvider
public ReportParameterAttr getReportParameterAttr()
getReportParameterAttr
在接口中 TemplateWorkBook
public void setReportParameterAttr(ReportParameterAttr reportParameterAttr)
setReportParameterAttr
在接口中 TemplateWorkBook
reportParameterAttr
- 参数属性public java.lang.String[] getJSImport()
getJSImport
在接口中 ImportJsCssProvider
public java.lang.String[] getCSSImport()
getCSSImport
在接口中 ImportJsCssProvider
public void readXML(XMLableReader reader)
XMLReadable
readXML
在接口中 XMLReadable
reader
- XML读取对象XMLableReader
public void writeXML(XMLPrintWriter writer)
XMLWriter
public AbstractWorkBookX clone()
clone
在接口中 FCloneable
clone
在类中 AbstractDocumentPart
public final void write(java.io.OutputStream stream) throws java.io.IOException
stream
- 输出流java.io.IOException
- 输出失败public boolean export(java.io.OutputStream out) throws java.lang.Exception
@Nonnull public abstract BaseDocPart getBaseDocPart()
@Nonnull public abstract AttributeDocPart getAttributeDocPart()
@Nonnull public abstract ExtraDocPart getExtraDocPart()
public abstract ParameterDocPart getParameterDocPart()
@Nonnull public abstract TableDataSourcePart getTableDataSourcePart()
@Nonnull public abstract ReportDocPart getReportDocPart()
@Nonnull public abstract StyleDocPart getStyleDocPart()
public abstract void prepareWrite() throws java.io.IOException
java.io.IOException
- 保存失败@Nonnull public abstract PictureDocPart getPicture(java.lang.String uri)
uri
- 块 uri@Nonnull public abstract PictureCollection getPictureCollection()
public abstract java.lang.String addPicture(byte[] pictureData, java.lang.String suffix) throws java.io.IOException
pictureData
- 图片的 bytes 数据suffix
- 图片格式后缀java.io.IOException
- 添加失败MediaSchemas.IMAGE_JPEG
,
MediaSchemas.IMAGE_PNG
,
MediaSchemas.IMAGE_BMP
,
MediaSchemas.IMAGE_GIF
,
getPictureCollection()
public abstract java.lang.String addPicture(java.io.InputStream is, java.lang.String suffix) throws java.io.IOException
is
- 输入流suffix
- 图片格式后缀java.io.IOException
- 添加失败MediaSchemas.IMAGE_JPEG
,
MediaSchemas.IMAGE_PNG
,
MediaSchemas.IMAGE_BMP
,
MediaSchemas.IMAGE_GIF
,
getPictureCollection()
public abstract java.lang.String addPicture(java.awt.Image im, java.lang.String suffix) throws java.io.IOException
im
- 图片对象suffix
- 图片格式后缀java.io.IOException
- 添加失败MediaSchemas.IMAGE_JPEG
,
MediaSchemas.IMAGE_PNG
,
MediaSchemas.IMAGE_BMP
,
MediaSchemas.IMAGE_GIF
,
getPictureCollection()
,
addPicture(InputStream is, String suffix)
,
addPicture(byte[] pictureData, String suffix)
public abstract void removePicture(java.lang.String uri)
uri
- 图片uri@Nonnull public abstract RawDataPart getRawDataPart(java.lang.String uri)
uri
- 块 uripublic abstract RawDataPart addRawData(byte[] bytes) throws java.io.IOException
bytes
- 数据java.io.IOException
- 添加异常public abstract void removeRawData(java.lang.String uri)
uri
- 块uri