Document (ofdrw-core 1.13.4 API)

java.lang.Object
- org.ofdrw.core.DefaultElementProxy
- - org.ofdrw.core.OFDElement
  - - org.ofdrw.core.basicStructure.doc.Document

所有已实现的接口:

Cloneable, org.dom4j.Branch, org.dom4j.Element, org.dom4j.Node
```
public class Document
extends OFDElement
```
文档根节点 Document.xml
————《GB/T 33190-2016》图 5

从以下版本开始:

2019-10-04 07:43:14

作者:

权观宇

字段概要
- 从类继承的字段 org.ofdrw.core.DefaultElementProxy
  proxy
- 从接口继承的字段 org.dom4j.Node
  ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

构造器概要

构造器
构造器和说明

Document()

Document(org.dom4j.Element proxy)

构造器
构造器和说明
`Document()`
`Document(org.dom4j.Element proxy)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Actions`	`getActions()` 【可选】获取文档关联的动作序列当存在多个 Action 对象时，所有动作依次执行
`ST_Loc`	`getAnnotations()` 【可选】获取指向注释列表的文件有关注释描述见第 15 章
`ST_Loc`	`getAttachments()` 【可选】获取指向附件列表文件有关附件描述见第 20 章
`Bookmarks`	`getBookmarks()` 【可选】获取文档的书签集，包含一组书签 7.5 文档根节点表 5 文档根节点属性
`CT_CommonData`	`getCommonData()` 【必选】获取文档公共数据定义了页面区域、公共资源
`ST_Loc`	`getCustomTags()` 【可选】获取指向自定义标引列表文件有关自定义标引描述见第 16 章
`ST_Loc`	`getExtensions()` 【可选】设置指向扩展列表文件有关扩展列表文件见第 17 章
`Outlines`	`getOutlines()` 【可选】获取大纲
`Pages`	`getPages()` 【必选】获取页树有关页树的描述键 7.6
`CT_Permission`	`getPermission()` 【可选】获取文档的权限声明
`CT_VPreferences`	`getVPreferences()` 【可选】获取文档的视图首选项
`Document`	`setActions(Actions actions)` 【可选】设置文档关联的动作序列当存在多个 Action 对象时，所有动作依次执行
`Document`	`setAnnotations(ST_Loc annotations)` 【可选】设置指向注释列表的文件有关注释描述见第 15 章
`Document`	`setAttachments(ST_Loc attachments)` 【可选】设置指向附件列表文件有关附件描述见第 20 章
`Document`	`setBookmarks(Bookmarks bookmarks)` 【可选】设置文档的书签集，包含一组书签 7.5 文档根节点表 5 文档根节点属性
`Document`	`setCommonData(CT_CommonData commonData)` 【必选】设置文档公共数据定义了页面区域、公共资源
`Document`	`setCustomTags(ST_Loc customTags)` 【可选】设置指向自定义标引列表文件有关自定义标引描述见第 16 章
`Document`	`setExtensions(ST_Loc extensions)` 【可选】设置指向扩展列表文件有关扩展列表文件见第 17 章
`Document`	`setOutlines(Outlines outlines)` 【可选】设置大纲
`Document`	`setPages(Pages pages)` 【必选】设置页树有关页树的描述键 7.6
`Document`	`setPermissions(CT_Permission permission)` 【可选】设置文档的权限声明
`Document`	`setVPreferences(CT_VPreferences vPreferences)` 【可选】设置文档的视图首选项

从类继承的方法 org.ofdrw.core.OFDElement
addOFDEntity, getElements, getInstance, getObjID, getOFDElement, getOFDElement, getOFDElements, getOFDElementText, getQualifiedName, removeAll, removeAttr, removeOFDElemByNames, set, setObjID, setObjID, setOFDEntity, setOFDName

从类继承的方法 org.ofdrw.core.DefaultElementProxy
accept, add, add, add, add, add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addElement, addElement, addElement, addEntity, additionalNamespaces, addNamespace, addProcessingInstruction, addProcessingInstruction, addText, appendAttributes, appendContent, asXML, asXPathResult, attribute, attribute, attribute, attributeCount, attributeIterator, attributes, attributeValue, attributeValue, attributeValue, attributeValue, clearContent, clone, content, createCopy, createCopy, createCopy, createXPath, declaredNamespaces, detach, element, element, elementByID, elementIterator, elementIterator, elementIterator, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, equals, getData, getDocument, getName, getNamespace, getNamespaceForPrefix, getNamespaceForURI, getNamespacePrefix, getNamespacesForURI, getNamespaceURI, getNodeType, getNodeTypeName, getParent, getPath, getPath, getProxy, getQName, getQName, getStringValue, getText, getTextTrim, getUniquePath, getUniquePath, getXPathResult, hasContent, hasMixedContent, indexOf, isReadOnly, isRootElement, isTextOnly, matches, node, nodeCount, nodeIterator, normalize, numberValueOf, processingInstruction, processingInstructions, processingInstructions, remove, remove, remove, remove, remove, remove, remove, remove, remove, removeProcessingInstruction, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setAttributes, setAttributeValue, setAttributeValue, setContent, setData, setDocument, setName, setParent, setProcessingInstructions, setProxy, setQName, setText, supportsParent, valueOf, write

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

- 构造器详细资料
  - Document
```
public Document(org.dom4j.Element proxy)
```
  - Document
```
public Document()
```
- 方法详细资料
  - setCommonData
```
public Document setCommonData(CT_CommonData commonData)
```
    【必选】设置文档公共数据
    定义了页面区域、公共资源
    
    参数:
    
    commonData - 文档公共数据
    
    返回:
    
    this
  - getCommonData
```
public CT_CommonData getCommonData()
```
    【必选】获取文档公共数据
    定义了页面区域、公共资源
    
    返回:
    
    文档公共数据
  - setPages
```
public Document setPages(Pages pages)
```
    【必选】设置页树
    有关页树的描述键 7.6
    
    参数:
    
    pages - 页树
    
    返回:
    
    this
  - getPages
```
public Pages getPages()
```
    【必选】获取页树
    有关页树的描述键 7.6
    
    返回:
    
    页树
  - setOutlines
```
public Document setOutlines(Outlines outlines)
```
    【可选】设置大纲
    
    参数:
    
    outlines - 大纲
    
    返回:
    
    this
  - getOutlines
```
public Outlines getOutlines()
```
    【可选】获取大纲
    
    返回:
    
    大纲
  - setPermissions
```
public Document setPermissions(CT_Permission permission)
```
    【可选】设置文档的权限声明
    
    参数:
    
    permission - 文档的权限声明
    
    返回:
    
    this
  - getPermission
```
public CT_Permission getPermission()
```
    【可选】获取文档的权限声明
    
    返回:
    
    文档的权限声明
  - setActions
```
public Document setActions(Actions actions)
```
    【可选】设置文档关联的动作序列
    当存在多个 Action 对象时，所有动作依次执行
    
    参数:
    
    actions - 文档关联的动作序列
    
    返回:
    
    this
  - getActions
```
public Actions getActions()
```
    【可选】获取文档关联的动作序列
    当存在多个 Action 对象时，所有动作依次执行
    
    返回:
    
    文档关联的动作序列
  - setVPreferences
```
public Document setVPreferences(CT_VPreferences vPreferences)
```
    【可选】设置文档的视图首选项
    
    参数:
    
    vPreferences - 文档的视图首选项
    
    返回:
    
    this
  - getVPreferences
```
public CT_VPreferences getVPreferences()
```
    【可选】获取文档的视图首选项
    
    返回:
    
    文档的视图首选项
  - setBookmarks
```
public Document setBookmarks(Bookmarks bookmarks)
```
    【可选】设置文档的书签集，包含一组书签
    7.5 文档根节点表 5 文档根节点属性
    
    参数:
    
    bookmarks - 文档的书签集
    
    返回:
    
    this
  - getBookmarks
```
public Bookmarks getBookmarks()
```
    【可选】获取文档的书签集，包含一组书签
    7.5 文档根节点表 5 文档根节点属性
    
    返回:
    
    文档的书签集
  - setAnnotations
```
public Document setAnnotations(ST_Loc annotations)
```
    【可选】设置指向注释列表的文件
    有关注释描述见第 15 章
    
    参数:
    
    annotations - 指向注释列表的文件路径
    
    返回:
    
    this
  - getAnnotations
```
public ST_Loc getAnnotations()
```
    【可选】获取指向注释列表的文件
    有关注释描述见第 15 章
    
    返回:
    
    指向注释列表的文件路径
  - setCustomTags
```
public Document setCustomTags(ST_Loc customTags)
```
    【可选】设置指向自定义标引列表文件
    有关自定义标引描述见第 16 章
    
    参数:
    
    customTags - 指向自定义标引列表文件路径
    
    返回:
    
    this
  - getCustomTags
```
public ST_Loc getCustomTags()
```
    【可选】获取指向自定义标引列表文件
    有关自定义标引描述见第 16 章
    
    返回:
    
    指向自定义标引列表文件路径
  - setAttachments
```
public Document setAttachments(ST_Loc attachments)
```
    【可选】设置指向附件列表文件
    有关附件描述见第 20 章
    
    参数:
    
    attachments - 指向附件列表文件路径
    
    返回:
    
    this
  - getAttachments
```
public ST_Loc getAttachments()
```
    【可选】获取指向附件列表文件
    有关附件描述见第 20 章
    
    返回:
    
    指向附件列表文件路径
  - setExtensions
```
public Document setExtensions(ST_Loc extensions)
```
    【可选】设置指向扩展列表文件
    有关扩展列表文件见第 17 章
    
    参数:
    
    extensions - 指向扩展列表文件路径
    
    返回:
    
    this
  - getExtensions
```
public ST_Loc getExtensions()
```
    【可选】设置指向扩展列表文件
    有关扩展列表文件见第 17 章
    
    返回:
    
    指向扩展列表文件路径

类 Document

字段概要

从类继承的字段 org.ofdrw.core.DefaultElementProxy

从接口继承的字段 org.dom4j.Node

构造器概要

方法概要

从类继承的方法 org.ofdrw.core.OFDElement

从类继承的方法 org.ofdrw.core.DefaultElementProxy

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

构造器详细资料

Document

Document

方法详细资料

setCommonData

getCommonData

setPages

getPages

setOutlines

getOutlines

setPermissions

getPermission

setActions

getActions

setVPreferences

getVPreferences

setBookmarks

getBookmarks

setAnnotations

getAnnotations

setCustomTags

getCustomTags

setAttachments

getAttachments

setExtensions

getExtensions