org.dromara.pdf.fop.core.doc

Class Document

java.lang.Object

org.dromara.pdf.fop.core.doc.Document

All Implemented Interfaces:

DocumentComponent

public class Document
extends Object
implements DocumentComponent

pdf模板-文档

Since:

1.8

Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-fop is licensed under the 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.

Author:

xsx

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Modifier and Type	Method and Description
Document	addBookmark(BookmarkComponent... bookmarks) 添加书签组件
Document	addBookmark(List<BookmarkComponent> bookmarks) 添加书签组件
Document	addPage(PageComponent... pages) 添加页面组件
String	getContent() 获取xsl-fo文档内容
Document	getDocument() 获取xsl-fo文档
Integer	getTotalPage() 获取总页数
void	save(OutputStream outputStream) 保存模板
void	save(String path) 保存模板
Document	setAuthor(String author) 设置作者
Document	setConfigPath(String configPath) 设置配置文件路径（fop配置文件路径）
Document	setCreationDate(Date date) 设置创建时间
Document	setCreator(String creator) 设置创建者
Document	setKeywords(String keywords) 设置关键词
Document	setSubject(String subject) 设置主题
Document	setTitle(String title) 设置标题
Document	transform() 转换
void	transform(OutputStream outputStream) 转换

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dromara.pdf.fop.core.doc.DocumentComponent

transform

Constructor Detail

Document

public Document()

Method Detail

setConfigPath

public Document setConfigPath(String configPath)

设置配置文件路径（fop配置文件路径）

注：此路径为绝对路径

Parameters:

configPath - 配置文件路径（绝对路径）

Returns:

返回pdf模板-文档

setTitle

public Document setTitle(String title)

设置标题

Parameters:

title - 标题

Returns:

返回pdf模板-文档

setAuthor

public Document setAuthor(String author)

设置作者

Parameters:

author - 作者

Returns:

返回pdf模板-文档

setSubject

public Document setSubject(String subject)

设置主题

Parameters:

subject - 主题

Returns:

返回pdf模板-文档

setKeywords

public Document setKeywords(String keywords)

设置关键词

Parameters:

keywords - 关键词

Returns:

返回pdf模板-文档

setCreator

public Document setCreator(String creator)

设置创建者

Parameters:

creator - 创建者

Returns:

返回pdf模板-文档

setCreationDate

public Document setCreationDate(Date date)

设置创建时间

Parameters:

date - 创建时间

Returns:

返回pdf模板-文档

addPage

public Document addPage(PageComponent... pages)

添加页面组件

注：不推荐添加多个页面，会影响总页码的准确性

Parameters:

pages - 页面组件列表

Returns:

返回pdf模板-文档

addBookmark

public Document addBookmark(BookmarkComponent... bookmarks)

添加书签组件

Parameters:

bookmarks - 书签组件列表

Returns:

返回pdf模板-文档

addBookmark

public Document addBookmark(List<BookmarkComponent> bookmarks)

添加书签组件

Parameters:

bookmarks - 书签组件列表

Returns:

返回pdf模板-文档

save

public void save(String path)

保存模板

Parameters:

path - 保存路径

save

public void save(OutputStream outputStream)

保存模板

Parameters:

outputStream - 输出流

transform

public Document transform()

转换

Returns:

返回pdf文档

transform

public void transform(OutputStream outputStream)

转换

Specified by:

transform in interface DocumentComponent

Parameters:

outputStream - 输出流

getDocument

public Document getDocument()

获取xsl-fo文档

Specified by:

getDocument in interface DocumentComponent

Returns:

返回xsl-fo文档

getContent

public String getContent()

获取xsl-fo文档内容

Returns:

返回文档内容

getTotalPage

public Integer getTotalPage()

获取总页数

Returns:

返回总页数