org.ofdrw.layout.areaholder

Class CT_AreaHolderBlock

java.lang.Object

org.ofdrw.core.DefaultElementProxy

org.ofdrw.core.OFDElement

org.ofdrw.layout.areaholder.CT_AreaHolderBlock

All Implemented Interfaces:

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

public class CT_AreaHolderBlock
extends org.ofdrw.core.OFDElement

【OFDRW 扩展】 区域占位区块

该元素用于存储和表示文档生成者在文档中预置的绘制区域占位符。

Since:

2023-10-28 15:02:23

Author:

权观宇

Field Summary

Fields inherited from class org.ofdrw.core.OFDElement

NSStrictMode

Fields inherited from class org.ofdrw.core.DefaultElementProxy

proxy

Fields inherited from interface 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

Constructor Summary

Constructors

Constructor and Description
CT_AreaHolderBlock()
CT_AreaHolderBlock(org.dom4j.Element proxy)
CT_AreaHolderBlock(String areaName) 创建 区域占位区块

Method Summary

Modifier and Type	Method and Description
String	getAreaName() 【必选 属性】 获取 区域名称
org.ofdrw.core.basicType.ST_Box	getBoundary() 【必选 属性】 获取 区域外接矩形
org.ofdrw.core.basicType.ST_Loc	getFontFile() 【必选】 获取 页面文件
org.ofdrw.core.basicType.ST_RefID	getPageBlockID() 【必选 属性】 获取 页块引用
CT_AreaHolderBlock	setAreaName(String areaName) 【必选 属性】 设置 区域名称
CT_AreaHolderBlock	setBoundary(org.ofdrw.core.basicType.ST_Box boundary) 【必选 属性】 设置 区域外接矩形
CT_AreaHolderBlock	setFontFile(String absPath) 【必选】 设置 页面文件
CT_AreaHolderBlock	setPageBlockID(org.ofdrw.core.basicType.ST_RefID pageBlockID) 【必选 属性】 设置 页块引用
CT_AreaHolderBlock	setPageFile(org.ofdrw.core.basicType.ST_Loc pageLoc) 【必选】 设置 页面文件

Methods inherited from class org.ofdrw.core.OFDElement

addOFDEntity, getElements, getInstance, getObjID, getOFDElement, getOFDElement, getOFDElements, getOFDElementText, getQualifiedName, removeAll, removeAttr, removeOFDElemByNames, set, setObjID, setObjID, setObjID, setOFDEntity, setOFDName

Methods inherited from class 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

Methods inherited from class java.lang.Object

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

Constructor Detail

CT_AreaHolderBlock

public CT_AreaHolderBlock(org.dom4j.Element proxy)

CT_AreaHolderBlock

public CT_AreaHolderBlock()

CT_AreaHolderBlock

public CT_AreaHolderBlock(String areaName)

创建 区域占位区块

Parameters:

areaName - 区域名称

Method Detail

setAreaName

public CT_AreaHolderBlock setAreaName(String areaName)

【必选 属性】 设置 区域名称

Parameters:

areaName - 区域名称

Returns:

this

getAreaName

public String getAreaName()

【必选 属性】 获取 区域名称

Returns:

区域名称

setPageBlockID

public CT_AreaHolderBlock setPageBlockID(org.ofdrw.core.basicType.ST_RefID pageBlockID)

【必选 属性】 设置 页块引用

通过该ID在页面中定位容器元素。

Parameters:

pageBlockID - 页块引用

Returns:

this

getPageBlockID

public org.ofdrw.core.basicType.ST_RefID getPageBlockID()

【必选 属性】 获取 页块引用

通过该ID在页面中定位容器元素。

Returns:

页块引用

setBoundary

public CT_AreaHolderBlock setBoundary(org.ofdrw.core.basicType.ST_Box boundary)

【必选 属性】 设置 区域外接矩形

区域占位区块在页面中的位置和大小。

Parameters:

boundary - 区域外接矩形

Returns:

this

getBoundary

public org.ofdrw.core.basicType.ST_Box getBoundary()

【必选 属性】 获取 区域外接矩形

区域占位区块在页面中的位置和大小。

Returns:

区域外接矩形

setPageFile

public CT_AreaHolderBlock setPageFile(org.ofdrw.core.basicType.ST_Loc pageLoc)

【必选】 设置 页面文件

Parameters:

pageLoc - 页面文件路径，占位区域块所在页面的在OFD容器中的绝对路径。

Returns:

this

setFontFile

public CT_AreaHolderBlock setFontFile(String absPath)

【必选】 设置 页面文件

Parameters:

absPath - 页面文件路径，占位区域块所在页面的在OFD容器中的绝对路径。

Returns:

this

getFontFile

public org.ofdrw.core.basicType.ST_Loc getFontFile()

【必选】 获取 页面文件

Returns:

占位区域块所在页面的在OFD容器中的绝对路径。