org.ofdrw.core.basicStructure.doc

类 CT_PageArea

java.lang.Object

org.ofdrw.core.DefaultElementProxy

org.ofdrw.core.OFDElement

org.ofdrw.core.basicStructure.doc.CT_PageArea

所有已实现的接口:

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

public class CT_PageArea
extends OFDElement

页面区域结构

————《GB/T 33190-2016》 图 7

从以下版本开始:

2019-10-04 08:58:55

作者:

权观宇

字段概要

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

构造器概要

构造器

构造器和说明
CT_PageArea()
CT_PageArea(double topLeftX, double topLeftY, double width, double height) 页面物理区域 创建区域
CT_PageArea(org.dom4j.Element proxy)

方法概要

限定符和类型	方法和说明
ST_Box	getApplicationBox() 【可选】 获取 显示区域 页面内容实际显示或打印输出的区域，位于页面物理区域内， 包含页眉、页脚、页心等内容 [例外处理] 如果显示区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。
ST_Box	getBleedBox() 【可选】 获取 出血区域 超出设备性能限制的额外出血区域，位于页面物理区域外。
ST_Box	getBox() 尝试获取页面最大区域 PhysicalBox | ApplicationBox| ContentBox
ST_Box	getContentBox() 【可选】 获取 版心区域 文件的正文区域，位于显示区域内。
ST_Box	getPhysicalBox() 【必选】 获取 页面物理区域 左上角为页面坐标系的原点
CT_PageArea	setApplicationBox(double topLeftX, double topLeftY, double width, double height) 【可选】 设置 显示区域 页面内容实际显示或打印输出的区域，位于页面物理区域内， 包含页眉、页脚、页心等内容 [例外处理] 如果显示区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。
CT_PageArea	setApplicationBox(ST_Box applicationBox) 【可选】 设置 显示区域 页面内容实际显示或打印输出的区域，位于页面物理区域内， 包含页眉、页脚、页心等内容 [例外处理] 如果显示区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。
CT_PageArea	setBleedBox(double topLeftX, double topLeftY, double width, double height) 【可选】 设置 出血区域 超出设备性能限制的额外出血区域，位于页面物理区域外。
CT_PageArea	setBleedBox(ST_Box bleedBox) 【可选】 设置 出血区域 超出设备性能限制的额外出血区域，位于页面物理区域外。
CT_PageArea	setContentBox(double topLeftX, double topLeftY, double width, double height) 【可选】 设置 版心区域 文件的正文区域，位于显示区域内。
CT_PageArea	setContentBox(ST_Box contentBox) 【可选】 设置 版心区域 文件的正文区域，位于显示区域内。
CT_PageArea	setPhysicalBox(double topLeftX, double topLeftY, double width, double height) 【必选】 设置 页面物理区域 左上角为页面坐标系的原点
CT_PageArea	setPhysicalBox(ST_Box physicalBox) 【必选】 设置 页面物理区域 左上角为页面坐标系的原点

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

构造器详细资料

CT_PageArea

public CT_PageArea(org.dom4j.Element proxy)

CT_PageArea

public CT_PageArea()

CT_PageArea

public CT_PageArea(double topLeftX,
                   double topLeftY,
                   double width,
                   double height)

页面物理区域 创建区域

参数:

topLeftX - 页面物理区域 左上角X坐标

topLeftY - 页面物理区域 左上角Y坐标

width - 页面物理区域 宽度

height - 页面物理区域 高度

方法详细资料

setPhysicalBox

public CT_PageArea setPhysicalBox(ST_Box physicalBox)

【必选】 设置 页面物理区域

左上角为页面坐标系的原点

参数:

physicalBox - 页面物理区域

返回:

this

setPhysicalBox

public CT_PageArea setPhysicalBox(double topLeftX,
                                  double topLeftY,
                                  double width,
                                  double height)

【必选】 设置 页面物理区域

左上角为页面坐标系的原点

参数:

topLeftX - 左上角X坐标

topLeftY - 左上角Y坐标

width - 宽度

height - 高度

返回:

this

getPhysicalBox

public ST_Box getPhysicalBox()

【必选】 获取 页面物理区域 左上角为页面坐标系的原点

返回:

页面物理区域

setApplicationBox

public CT_PageArea setApplicationBox(ST_Box applicationBox)

【可选】 设置 显示区域

页面内容实际显示或打印输出的区域，位于页面物理区域内， 包含页眉、页脚、页心等内容

[例外处理] 如果显示区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果显示区域完全位于页面物理区域外， 则设置该页为空白页。

参数:

applicationBox - 显示区域

返回:

this

setApplicationBox

public CT_PageArea setApplicationBox(double topLeftX,
                                     double topLeftY,
                                     double width,
                                     double height)

【可选】 设置 显示区域

页面内容实际显示或打印输出的区域，位于页面物理区域内， 包含页眉、页脚、页心等内容

[例外处理] 如果显示区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果显示区域完全位于页面物理区域外， 则设置该页为空白页。

参数:

topLeftX - 左上角X坐标

topLeftY - 左上角Y坐标

width - 宽度

height - 高度

返回:

this

getApplicationBox

public ST_Box getApplicationBox()

【可选】 获取 显示区域

页面内容实际显示或打印输出的区域，位于页面物理区域内， 包含页眉、页脚、页心等内容

[例外处理] 如果显示区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果显示区域完全位于页面物理区域外， 则设置该页为空白页。

返回:

显示区域

setContentBox

public CT_PageArea setContentBox(ST_Box contentBox)

【可选】 设置 版心区域

文件的正文区域，位于显示区域内。 左上角坐标决定了其在显示区域内的位置

[例外处理] 如果版心区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果版心区域完全位于页面物理区域外， 则设置该页为空白页。

参数:

contentBox - 版心区域

返回:

this

setContentBox

public CT_PageArea setContentBox(double topLeftX,
                                 double topLeftY,
                                 double width,
                                 double height)

【可选】 设置 版心区域

文件的正文区域，位于显示区域内。 左上角坐标决定了其在显示区域内的位置

[例外处理] 如果版心区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果版心区域完全位于页面物理区域外， 则设置该页为空白页。

参数:

topLeftX - 左上角X坐标

topLeftY - 左上角Y坐标

width - 宽度

height - 高度

返回:

this

getContentBox

public ST_Box getContentBox()

【可选】 获取 版心区域

文件的正文区域，位于显示区域内。 左上角坐标决定了其在显示区域内的位置

[例外处理] 如果版心区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果版心区域完全位于页面物理区域外， 则设置该页为空白页。

返回:

版心区域

setBleedBox

public CT_PageArea setBleedBox(ST_Box bleedBox)

【可选】 设置 出血区域

超出设备性能限制的额外出血区域，位于页面物理区域外。 不出现时，默认值为页面物理区域

[例外处理] 如果出血区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果显示出血完全位于页面物理区域外， 则设置该页为空白页。

参数:

bleedBox - 出血区域

返回:

this

setBleedBox

public CT_PageArea setBleedBox(double topLeftX,
                               double topLeftY,
                               double width,
                               double height)

【可选】 设置 出血区域

超出设备性能限制的额外出血区域，位于页面物理区域外。 不出现时，默认值为页面物理区域

[例外处理] 如果出血区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果显示出血完全位于页面物理区域外， 则设置该页为空白页。

参数:

topLeftX - 左上角X坐标

topLeftY - 左上角Y坐标

width - 宽度

height - 高度

返回:

this

getBleedBox

public ST_Box getBleedBox()

【可选】 获取 出血区域

超出设备性能限制的额外出血区域，位于页面物理区域外。 不出现时，默认值为页面物理区域

[例外处理] 如果出血区域不完全位于页面物理区域内， 页面物理区域外的部分则被忽略。如果显示出血完全位于页面物理区域外， 则设置该页为空白页。

返回:

出血区域

getBox

public ST_Box getBox()

尝试获取页面最大区域

PhysicalBox | ApplicationBox| ContentBox

返回:

区域