org.ofdrw.core.basicStructure.pageObj

类 Page

java.lang.Object

org.ofdrw.core.DefaultElementProxy

org.ofdrw.core.OFDElement

org.ofdrw.core.basicStructure.pageObj.Page

所有已实现的接口:

Cloneable, org.dom4j.Branch, org.dom4j.Element, org.dom4j.Node

public class Page
extends OFDElement

页对象

页对象支持模板页描述，每一页经常要重复显示的内容可统一在模板页中描述， 文档可以包含多个模板页。通过使用模板页可以使重复显示的内容不必出现在 描述每一页的页面描述内容中，而只需通过 Template 节点进行应用。

7.7 图 13 页对象结构；表 12 页对象属性

从以下版本开始:

2019-10-09 09:38:35

作者:

权观宇

字段概要

从类继承的字段 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

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
Page	addPageRes(ST_Loc pageRes) 【可选】 设置 页资源 指向该页使用的资源文件
Page	addTemplate(Template template) 【可选】 设置 页面使用的模板页 模板页的内容和结构与普通页相同，定义在 CommonData 指定的 XML 文件中。
Actions	getActions() 【可选】 设置 与页面关联的动作序列。
CT_PageArea	getArea() 【可选】 获取 页面区域的大小和位置，仅对该页面有效。
Content	getContent() 【可选】 获取 页面内容描述，该节点不存在时，标识空白页
List<ST_Loc>	getPageResList() 【可选】 获取 页资源 指向该页使用的资源文件
Template	getTemplate() 已过时。 getTemplates()
List<Template>	getTemplates() 【可选】 获取 页面使用的模板页 模板页的内容和结构与普通页相同，定义在 CommonData 指定的 XML 文件中。
Page	setActions(Actions actions) 【可选】 设置 与页面关联的动作序列。
Page	setArea(CT_PageArea area) 【可选】 设置 页面区域的大小和位置，仅对该页面有效。
Page	setContent(Content content) 【可选】 设置 页面内容描述，该节点不存在时，标识空白页
Page	setTemplate(Template template) 已过时。 addTemplate(Template)

从类继承的方法 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

构造器详细资料

Page

public Page(org.dom4j.Element proxy)

Page

public Page()

方法详细资料

setArea

public Page setArea(CT_PageArea area)

【可选】 设置 页面区域的大小和位置，仅对该页面有效。

该节点不出现时则使用模板页中的定义，如果模板页不存在或模板页中 没有定义页面区域，则使用文件 CommonData 中的定义。

参数:

area - 页面区域的大小和位置

返回:

this

getArea

public CT_PageArea getArea()

【可选】 获取 页面区域的大小和位置，仅对该页面有效。

该节点不出现时则使用模板页中的定义，如果模板页不存在或模板页中 没有定义页面区域，则使用文件 CommonData 中的定义。

返回:

页面区域的大小和位置

addTemplate

public Page addTemplate(Template template)

【可选】 设置 页面使用的模板页

模板页的内容和结构与普通页相同，定义在 CommonData 指定的 XML 文件中。一个页可以使用多个模板页。该节点 使用是通过 TemplateID 来引用具体模板，并通过 ZOrder 属性来控制模板在页面中的显示顺序。

注：在模板页的内容描述中该属性无效。

参数:

template - 页面使用的模板页

返回:

this

setTemplate

@Deprecated
public Page setTemplate(Template template)

已过时。 addTemplate(Template)

参数:

template - 模板

返回:

this

getTemplates

public List<Template> getTemplates()

【可选】 获取 页面使用的模板页

模板页的内容和结构与普通页相同，定义在 CommonData 指定的 XML 文件中。一个页可以使用多个模板页。该节点 使用是通过 TemplateID 来引用具体模板，并通过 ZOrder 属性来控制模板在页面中的显示顺序。

注：在模板页的内容描述中该属性无效。

返回:

页面使用的模板页

getTemplate

@Deprecated
public Template getTemplate()

已过时。 getTemplates()

返回:

页面使用的模板页(第一个)

addPageRes

public Page addPageRes(ST_Loc pageRes)

【可选】 设置 页资源

指向该页使用的资源文件

参数:

pageRes - 页资源路径

返回:

this

getPageResList

public List<ST_Loc> getPageResList()

【可选】 获取 页资源

指向该页使用的资源文件

返回:

页资源路径列表

setContent

public Page setContent(Content content)

【可选】 设置 页面内容描述，该节点不存在时，标识空白页

参数:

content - 页面内容

返回:

this

getContent

public Content getContent()

【可选】 获取 页面内容描述，该节点不存在时，标识空白页

返回:

页面内容

setActions

public Page setActions(Actions actions)

【可选】 设置 与页面关联的动作序列。

当存在多个 Action对象时，所有动作依次执行。

动作列表的动作与页面关联，事件类型为 PO（页面打开，见表 52 事件类型）

参数:

actions - 动作序列

返回:

this

getActions

public Actions getActions()

【可选】 设置 与页面关联的动作序列。

当存在多个 Action对象时，所有动作依次执行。

动作列表的动作与页面关联，事件类型为 PO（页面打开，见表 52 事件类型）

返回:

动作序列