OFDElement (ofdrw-core 1.13.4 API)

java.lang.Object
- org.ofdrw.core.DefaultElementProxy
- - org.ofdrw.core.OFDElement

所有已实现的接口:

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

直接已知子类:

AbbreviatedData, Actions, Annot, Annotations, AnnPage, Area, Attachments, Bookmark, Bookmark, Bookmarks, Border, Clips, ColorSpaces, Command, CompositeGraphicUnits, Content, CT_Action, CT_Area, CT_Attachment, CT_AxialShd, CT_CGTransform, CT_Clip, CT_Color, CT_ColorSpace, CT_CommonData, CT_Dest, CT_DocInfo, CT_DrawParam, CT_EncryptInfo, CT_Extension, CT_Font, CT_GouraudShd, CT_GraphicUnit, CT_MultiMedia, CT_OutlineElem, CT_PageArea, CT_PageBlock, CT_Pattern, CT_Permission, CT_RadialShd, CT_Region, CT_TemplatePage, CT_VectorG, CT_VPreferences, CustomData, CustomDatas, CustomTag, CustomTags, CV, DecyptSeed, DocBody, Document, DocVersion, DrawParams, EncryptEntries, EncryptEntry, Encryptions, ExtendParams, Extensions, File, File, FileList, FileList, Fonts, Goto, GotoA, Keywords, Movie, MultiMedias, OFD, OFDEntries, OFDSimpleTypeElement, Outlines, Page, Page, PageAnnot, Pages, Palette, Parameter, Parameter, Parameters, Point, Print, Property, Provider, Reference, References, Res, Seal, Segment, Signature, Signature, Signatures, SignedInfo, Sound, StampAnnot, Template, TextCode, URI, UserInfo, ValidPeriod, Version, Versions, ZoomScale
```
public class OFDElement
extends DefaultElementProxy
```
文件根节点
XML文档使用的命名空间为 http://www.ofdspec.org/2016，其表示符应为 ofd；应在包内各XML文档的根节点申明 defaults:ofd。元素节点应使用命名空间标识符，元素属性不使用命名空间标识符。 ————《GB/T 33190-2016》 7.1 命名空间

从以下版本开始:

2019-09-28 12:05: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

构造器概要

构造器
限定符构造器和说明

OFDElement(org.dom4j.Element proxy)

protected OFDElement(String name)

构造器
限定符	构造器和说明
	`OFDElement(org.dom4j.Element proxy)`
`protected`	`OFDElement(String name)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`OFDElement`	`addOFDEntity(String name, Serializable value)` 向元素中增加OFD元素
`<R> List<R>`	`getElements(String name, Function<? super org.dom4j.Element,? extends R> mapper)` 获取指定名称OFD元素集合集合将会保持原有次序 qname匹配的时候不再验证namespace，兼容namespace为空的情况。
`static OFDElement`	`getInstance(String name)`
`ST_ID`	`getObjID()` 【可选】设置 OFD对象标识，无符号整数，应在文档内唯一。
`org.dom4j.Element`	`getOFDElement(String name)` 获取OFD的元素
`<R extends OFDElement> R`	`getOFDElement(String name, Function<? super org.dom4j.Element,? extends R> mapper)` 代理对象创建
`<R> List<R>`	`getOFDElements(String name, Function<? super org.dom4j.Element,? extends R> mapper)` 获取指定名称OFD元素集合集合将会保持原有次序
`String`	`getOFDElementText(String name)` 获取OFD元素中的文本
`String`	`getQualifiedName()` OFD元素采用OFD的命名空间，所以直接调用代理对象
`OFDElement`	`removeAll()` 移除元素中所有内容
`boolean`	`removeAttr(String name)` 如果属性存在则删除
`List<org.dom4j.Element>`	`removeOFDElemByNames(String... names)` 根据 OFD元素的名称删除节点内所有匹配的OFD元素
`OFDElement`	`set(org.dom4j.Element element)` 设置元素如果同类型元素已经存在，那么删除原有元素
`OFDElement`	`setObjID(long objId)`
`OFDElement`	`setObjID(ST_ID objId)` 【可选】设置 OFD对象标识，无符号整数，应在文档内唯一。
`OFDElement`	`setOFDEntity(String name, Serializable value)` 设置OFD参数如果参数已经存在则修改参数如果属性值value为null，表示删除该类元素
`OFDElement`	`setOFDName(String name)` 设置元素名称

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

- 构造器详细资料
  - OFDElement
```
public OFDElement(org.dom4j.Element proxy)
```
  - OFDElement
```
protected OFDElement(String name)
```
- 方法详细资料
  - getInstance
```
public static OFDElement getInstance(String name)
```
    参数:
    
    name - 元素名称
    
    返回:
    
    获取OFD类型元素实例
  - addOFDEntity
```
public OFDElement addOFDEntity(String name,
                               Serializable value)
```
    向元素中增加OFD元素
    
    参数:
    
    name - 元素名称
    
    value - 元素文本
    
    返回:
    
    this
  - setOFDEntity
```
public OFDElement setOFDEntity(String name,
                               Serializable value)
```
    设置OFD参数
    如果参数已经存在则修改参数
    如果属性值value为null，表示删除该类元素
    
    参数:
    
    name - 元素名称
    
    value - 元素文本
    
    返回:
    
    this
  - setOFDName
```
public OFDElement setOFDName(String name)
```
    设置元素名称
    
    参数:
    
    name - 元素名称
    
    返回:
    
    this
  - getOFDElement
```
public org.dom4j.Element getOFDElement(String name)
```
    获取OFD的元素
    
    参数:
    
    name - OFD元素名称
    
    返回:
    
    OFD元素或null
  - getOFDElement
```
public <R extends OFDElement> R getOFDElement(String name,
                                              Function<? super org.dom4j.Element,? extends R> mapper)
```
    代理对象创建
    
    类型参数:
    
    R - 元素类型
    
    参数:
    
    name - 元素名称
    
    mapper - 代理对象构造器
    
    返回:
    
    代理对象
  - removeAttr
```
public boolean removeAttr(String name)
```
    如果属性存在则删除
    
    参数:
    
    name - 属性名
    
    返回:
    
    true 删除成功；false 删除失败，可能是由于属性不存在
  - getOFDElementText
```
public String getOFDElementText(String name)
```
    获取OFD元素中的文本
    
    参数:
    
    name - 元素名称
    
    返回:
    
    文本
  - getOFDElements
```
public <R> List<R> getOFDElements(String name,
                                  Function<? super org.dom4j.Element,? extends R> mapper)
```
    获取指定名称OFD元素集合
    集合将会保持原有次序
    
    类型参数:
    
    R - 指定元素对象
    
    参数:
    
    name - OFD元素名称
    
    mapper - 转换对象构造器引用
    
    返回:
    
    指定名称OFD元素集合
  - getElements
```
public <R> List<R> getElements(String name,
                               Function<? super org.dom4j.Element,? extends R> mapper)
```
    获取指定名称OFD元素集合
    集合将会保持原有次序 qname匹配的时候不再验证namespace，兼容namespace为空的情况。 author daiwf
    
    类型参数:
    
    R - 指定元素对象
    
    参数:
    
    name - OFD元素名称
    
    mapper - 转换对象构造器引用
    
    返回:
    
    指定名称OFD元素集合
  - set
```
public OFDElement set(org.dom4j.Element element)
```
    设置元素
    如果同类型元素已经存在，那么删除原有元素
    
    参数:
    
    element - 需要设置的元素
    
    返回:
    
    this
  - removeOFDElemByNames
```
public List<org.dom4j.Element> removeOFDElemByNames(String... names)
```
    根据 OFD元素的名称删除节点内所有匹配的OFD元素
    
    参数:
    
    names - 需要被删除元素名称序列
    
    返回:
    
    被删除的所有OFD元素
  - setObjID
```
public OFDElement setObjID(ST_ID objId)
```
    【可选】
    设置 OFD对象标识，无符号整数，应在文档内唯一。
    0标识无效标识符
    
    参数:
    
    objId - OFD对象标识
    
    返回:
    
    this
  - setObjID
```
public OFDElement setObjID(long objId)
```
  - removeAll
```
public OFDElement removeAll()
```
    移除元素中所有内容
    
    返回:
    
    this
  - getObjID
```
public ST_ID getObjID()
```
    【可选】
    设置 OFD对象标识，无符号整数，应在文档内唯一。
    0标识无效标识符
    
    返回:
    
    OFD对象标识，null表示对象标识不存在
  - getQualifiedName
```
public String getQualifiedName()
```
    OFD元素采用OFD的命名空间，所以直接调用代理对象
    
    指定者:
    
    getQualifiedName 在接口中 org.dom4j.Element
    
    指定者:
    
    getQualifiedName 在类中 DefaultElementProxy
    
    返回:
    
    元素全名（含有前缀）

类 OFDElement

字段概要

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

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

构造器概要

方法概要

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

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

构造器详细资料

OFDElement

OFDElement

方法详细资料

getInstance

addOFDEntity

setOFDEntity

setOFDName

getOFDElement

getOFDElement

removeAttr

getOFDElementText

getOFDElements

getElements

set

removeOFDElemByNames

setObjID

setObjID

removeAll

getObjID

getQualifiedName