JavaTM 2 Platform
Standard Ed. 6

javax.imageio.metadata
類別 IIOMetadataNode

java.lang.Object
  繼承者 javax.imageio.metadata.IIOMetadataNode
所有已實作的介面:
Element, Node, NodeList

public class IIOMetadataNode
extends Object
implements Element, NodeList

表示元資料階層樹中節點的類別,該類別實作 org.w3c.dom.Element 介面,還允許通過 getUserObjectsetUserObject 方法存儲非文本物件。

此類別不用於進行通用 XML 處理。尤其是,在 Image I/O API 中創建的 Element 節點與 SUN 的 org.w3.dom API 標準實作創建的節點不相容。特別是該實作經過調整只能用於一些簡單用途,它不能很好地進行密集處理。

在此實作中名稱空間將被忽略。術語“標記名稱”和“節點名稱”始終被視為同義。

另請參見:
IIOMetadata.getAsTree(java.lang.String), IIOMetadata.setFromTree(java.lang.String, org.w3c.dom.Node), IIOMetadata.mergeTree(java.lang.String, org.w3c.dom.Node)

欄位摘要
 
從介面 org.w3c.dom.Node 繼承的欄位
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
建構子摘要
IIOMetadataNode()
          建構一個空的 IIOMetadataNode
IIOMetadataNode(String nodeName)
          建構一個具有給定節點名稱的 IIOMetadataNode
 
方法摘要
 Node appendChild(Node newChild)
          將節點 newChild 添加到此節點子節點列表的末尾。
 Node cloneNode(boolean deep)
          返回此節點的副本。
 short compareDocumentPosition(Node other)
          就節點在文檔中的位置並按照文檔的順序,比較參考節點(即在其上調用此方法的節點)與作為參數傳遞的節點。
 String getAttribute(String name)
          通過名稱獲得屬性值。
 Attr getAttributeNode(String name)
          通過名稱獲得屬性節點。
 Attr getAttributeNodeNS(String namespaceURI, String localName)
          等效於 getAttributeNode(localName)
 String getAttributeNS(String namespaceURI, String localName)
          等效於 getAttribute(localName)
 NamedNodeMap getAttributes()
          包含此節點的屬性的 NamedNodeMap(如果它是 Element);否則為 null
 String getBaseURI()
          此節點的絕對基 URI;如果實作不能獲得絕對 URI,則為 null
 NodeList getChildNodes()
          包含此節點的所有子節點的 NodeList
 NodeList getElementsByTagName(String name)
          以文檔順序返回具有給定標記名稱的所有後代 ElementsNodeList
 NodeList getElementsByTagNameNS(String namespaceURI, String localName)
          等效於 getElementsByTagName(localName)
 Object getFeature(String feature, String version)
          此方法返回一個特定的物件,該物件實作指定功能或版本的特定 API,如下所述。
 Node getFirstChild()
          此節點的第一個子節點;如果該節點沒有子節點,則返回 null
 Node getLastChild()
          返回此節點的最後一個子節點;如果該節點沒有子節點,則返回 null
 int getLength()
          列表中的節點數。
 String getLocalName()
          等效於 getNodeName
 String getNamespaceURI()
          返回 null,因為不支持名稱空間。
 Node getNextSibling()
          返回此節點的下一個兄弟節點;如果該節點沒有下一個兄弟節點,則返回 null
 String getNodeName()
          返回與此節點關聯的節點名稱。
 short getNodeType()
          返回節點型別,其始終為 ELEMENT_NODE
 String getNodeValue()
          此節點的值,取決於其型別;參見上表。
 Document getOwnerDocument()
          返回 null,因為 IIOMetadataNode 不屬於任何 Document
 Node getParentNode()
          返回此節點的父節點。
 String getPrefix()
          返回 null,因為不支持名稱空間。
 Node getPreviousSibling()
          返回此節點的上一個兄弟節點;如果該節點沒有上一個兄弟節點,則返回 null
 TypeInfo getSchemaTypeInfo()
          與此元素相關的型別資訊。
 String getTagName()
          元素的名稱。
 String getTextContent()
          此屬性返回此節點及其後代的文本內容。
 Object getUserData(String key)
          檢索與此節點上的某個鍵相關聯的物件。
 Object getUserObject()
          返回與此節點關聯的 Object 值。
 boolean hasAttribute(String name)
          當具有給定名稱的屬性在此元素上被指定一個值或具有預設值時,返回 true;否則返回 false
 boolean hasAttributeNS(String namespaceURI, String localName)
          等效於 hasAttribute(localName)
 boolean hasAttributes()
          返回此節點(如果它是一個元素)是否具有任何屬性。
 boolean hasChildNodes()
          如果此節點有子節點,則返回 true
 Node insertBefore(Node newChild, Node refChild)
          在現有子節點 refChild 之前插入節點 newChild
 boolean isDefaultNamespace(String namespaceURI)
          此方法檢查指定的 namespaceURI 是否是預設名稱空間。
 boolean isEqualNode(Node node)
          測試兩個節點是否相等。
 boolean isSameNode(Node node)
          返回此節點是否是與給定節點相同的節點。
 boolean isSupported(String feature, String version)
          返回 false,因為不支持 DOM 功能。
 Node item(int index)
          返回集合中的第 index 個項。
 String lookupNamespaceURI(String prefix)
          從此節點開始,尋找與給定前綴相關的名稱空間 URI。
 String lookupPrefix(String namespaceURI)
          從此節點開始,尋找與給定名稱空間 URI 相關的前綴。
 void normalize()
          不執行任何操作,因為 IIOMetadataNode 不包含 Text 子節點。
 void removeAttribute(String name)
          通過名稱移除一個屬性。
 Attr removeAttributeNode(Attr oldAttr)
          移除指定的屬性節點。
 void removeAttributeNS(String namespaceURI, String localName)
          等效於 removeAttribute(localName)
 Node removeChild(Node oldChild)
          從子節點列表中移除 oldChild 所指示的子節點,並將其返回。
 Node replaceChild(Node newChild, Node oldChild)
          將子節點 oldChild 替換為子節點列表中的 newChild,並返回 oldChild 節點。
 void setAttribute(String name, String value)
          添加一個新屬性。
 Attr setAttributeNode(Attr newAttr)
          添加新的屬性節點。
 Attr setAttributeNodeNS(Attr newAttr)
          等效於 setAttributeNode(newAttr)
 void setAttributeNS(String namespaceURI, String qualifiedName, String value)
          等效於 setAttribute(qualifiedName, value)
 void setIdAttribute(String name, boolean isId)
          如果參數 isIdtrue,則此方法將指定的屬性宣告為用於確定使用者的 ID 屬性。
 void setIdAttributeNode(Attr idAttr, boolean isId)
          如果參數 isIdtrue,則此方法將指定的屬性宣告為使用者確定的 ID 屬性。
 void setIdAttributeNS(String namespaceURI, String localName, boolean isId)
          如果參數 isIdtrue,則此方法將指定的屬性宣告為使用者確定的 ID 屬性。
 void setNodeValue(String nodeValue)
          此節點的值,取決於其型別;參見上表。
 void setPrefix(String prefix)
          不執行任何操作,因為不支持名稱空間。
 void setTextContent(String textContent)
          此屬性返回此節點及其後代的文本內容。
 Object setUserData(String key, Object data, UserDataHandler handler)
          將對象與此節點上的鍵相關聯。
 void setUserObject(Object userObject)
          設置與此節點關聯的值。
 
從類別 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

建構子詳細資訊

IIOMetadataNode

public IIOMetadataNode()
建構一個空的 IIOMetadataNode


IIOMetadataNode

public IIOMetadataNode(String nodeName)
建構一個具有給定節點名稱的 IIOMetadataNode

參數:
nodeName - 以 String 形式表示的節點名稱。
方法詳細資訊

getNodeName

public String getNodeName()
返回與此節點關聯的節點名稱。

指定者:
介面 Node 中的 getNodeName
返回:
String 形式表示的節點名稱。

getNodeValue

public String getNodeValue()
                    throws DOMException
從介面 Node 複製的描述
此節點的值,取決於其型別;參見上表。當將它定義為 null 時,設置它無效,包括節點為只讀的情況。

指定者:
介面 Node 中的 getNodeValue
拋出:
DOMException - DOMSTRING_SIZE_ERR: 在它返回的字元多於實作平臺上 DOMString 變數中適合的字元時引發此異常。

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException
從介面 Node 複製的描述
此節點的值,取決於其型別;參見上表。當將它定義為 null 時,設置它無效,包括節點為只讀的情況。

指定者:
介面 Node 中的 setNodeValue
拋出:
DOMException - NO_MODIFICATION_ALLOWED_ERR: 當節點為只讀且未將它定義為 null 時引發此異常。

getNodeType

public short getNodeType()
返回節點型別,其始終為 ELEMENT_NODE

指定者:
介面 Node 中的 getNodeType
返回:
shortELEMENT_NODE

getParentNode

public Node getParentNode()
返回此節點的父節點。null 值指示該節點是它自己的階層樹的根。要在現有階層樹中添加節點,請使用 insertBeforereplaceChildappendChild 方法之一。

指定者:
介面 Node 中的 getParentNode
返回:
Node 形式表示的父節點。
另請參見:
insertBefore(org.w3c.dom.Node, org.w3c.dom.Node), replaceChild(org.w3c.dom.Node, org.w3c.dom.Node), appendChild(org.w3c.dom.Node)

getChildNodes

public NodeList getChildNodes()
從介面 Node 複製的描述
包含此節點的所有子節點的 NodeList。如果不存在子節點,則這是不包含節點的 NodeList

指定者:
介面 Node 中的 getChildNodes

getFirstChild

public Node getFirstChild()
此節點的第一個子節點;如果該節點沒有子節點,則返回 null

指定者:
介面 Node 中的 getFirstChild
返回:
Node 形式表示的第一個子節點;或者 null

getLastChild

public Node getLastChild()
返回此節點的最後一個子節點;如果該節點沒有子節點,則返回 null

指定者:
介面 Node 中的 getLastChild
返回:
Node 形式表示的最後一個子節點;或者 null

getPreviousSibling

public Node getPreviousSibling()
返回此節點的上一個兄弟節點;如果該節點沒有上一個兄弟節點,則返回 null

指定者:
介面 Node 中的 getPreviousSibling
返回:
Node 形式表示的上一個兄弟節點;或者 null

getNextSibling

public Node getNextSibling()
返回此節點的下一個兄弟節點;如果該節點沒有下一個兄弟節點,則返回 null

指定者:
介面 Node 中的 getNextSibling
返回:
Node 形式表示的下一個兄弟節點;或者 null

getAttributes

public NamedNodeMap getAttributes()
從介面 Node 複製的描述
包含此節點的屬性的 NamedNodeMap(如果它是 Element);否則為 null

指定者:
介面 Node 中的 getAttributes

getOwnerDocument

public Document getOwnerDocument()
返回 null,因為 IIOMetadataNode 不屬於任何 Document

指定者:
介面 Node 中的 getOwnerDocument
返回:
null

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
在現有子節點 refChild 之前插入節點 newChild。如果 refChildnull,則將 newChild 插入到子節點列表的末尾。

指定者:
介面 Node 中的 insertBefore
參數:
newChild - 要插入的 Node
refChild - 參考 Node
返回:
要插入的節點。
拋出:
IllegalArgumentException - 如果 newChildnull

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
將子節點 oldChild 替換為子節點列表中的 newChild,並返回 oldChild 節點。

指定者:
介面 Node 中的 replaceChild
參數:
newChild - 要插入的 Node
oldChild - 要替換的 Node
返回:
替換的節點。
拋出:
IllegalArgumentException - 如果 newChildnull

removeChild

public Node removeChild(Node oldChild)
從子節點列表中移除 oldChild 所指示的子節點,並將其返回。

指定者:
介面 Node 中的 removeChild
參數:
oldChild - 要移除的 Node
返回:
移除的節點。
拋出:
IllegalArgumentException - 如果 oldChildnull

appendChild

public Node appendChild(Node newChild)
將節點 newChild 添加到此節點子節點列表的末尾。

指定者:
介面 Node 中的 appendChild
參數:
newChild - 要插入的 Node
返回:
添加的節點。
拋出:
IllegalArgumentException - 如果 newChildnull

hasChildNodes

public boolean hasChildNodes()
如果此節點有子節點,則返回 true

指定者:
介面 Node 中的 hasChildNodes
返回:
如果此節點有子節點,則返回 true

cloneNode

public Node cloneNode(boolean deep)
返回此節點的副本。副本節點沒有父節點(getParentNode 返回 null)。如果正在執行淺表複製(deepfalse),則新節點將沒有任何子節點或兄弟節點。如果正在執行深層複製,則新節點將形成完整複製的子階層樹的根。

指定者:
介面 Node 中的 cloneNode
參數:
deep - 如果為 true,則在指定節點下遞歸式複製子階層樹;如果為 false,則僅複製節點本身。
返回:
副本節點。

normalize

public void normalize()
不執行任何操作,因為 IIOMetadataNode 不包含 Text 子節點。

指定者:
介面 Node 中的 normalize

isSupported

public boolean isSupported(String feature,
                           String version)
返回 false,因為不支持 DOM 功能。

指定者:
介面 Node 中的 isSupported
參數:
feature - 一個 String,忽略該參數。
version - 一個 String,忽略該參數。
返回:
false

getNamespaceURI

public String getNamespaceURI()
                       throws DOMException
返回 null,因為不支持名稱空間。

指定者:
介面 Node 中的 getNamespaceURI
拋出:
DOMException

getPrefix

public String getPrefix()
返回 null,因為不支持名稱空間。

指定者:
介面 Node 中的 getPrefix
返回:
null
另請參見:
setPrefix(java.lang.String)

setPrefix

public void setPrefix(String prefix)
不執行任何操作,因為不支持名稱空間。

指定者:
介面 Node 中的 setPrefix
參數:
prefix - 一個 String,忽略該參數。
另請參見:
getPrefix()

getLocalName

public String getLocalName()
等效於 getNodeName

指定者:
介面 Node 中的 getLocalName
返回:
String 形式表示的節點名稱。

getTagName

public String getTagName()
從介面 Element 複製的描述
元素的名稱。如果 Node.localNamenull 不同,則此屬性為一個限定名稱。例如,在以下範例中:
 <elementExample id="demo"> ... 
 </elementExample> , 
tagName 具有值 "elementExample"。注意,這在 XML 中是保留大小寫的,DOM 中的所有操作也是這樣。HTML DOM 以規範的大寫形式返回 HTML 元素的 tagName,而不考慮源 HTML 文檔中的大小寫形式。

指定者:
介面 Element 中的 getTagName

getAttribute

public String getAttribute(String name)
從介面 Element 複製的描述
通過名稱獲得屬性值。

指定者:
介面 Element 中的 getAttribute
參數:
name - 要獲得的屬性名稱。
返回:
字元串形式的 Attr 值;如果該屬性沒有指定值或預設值,則返回空字元串。

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)
等效於 getAttribute(localName)

指定者:
介面 Element 中的 getAttributeNS
參數:
namespaceURI - 要獲得的屬性的名稱空間 URI。
localName - 要獲得的屬性的本地名稱。
返回:
字元串形式的 Attr 值;如果該屬性沒有指定值或預設值,則返回空字元串。
另請參見:
setAttributeNS(java.lang.String, java.lang.String, java.lang.String)

setAttribute

public void setAttribute(String name,
                         String value)
從介面 Element 複製的描述
添加一個新屬性。如果具有該名稱的屬性已經出現在元素中,則將其值更改為值參數的值。此值為簡單的字元串;在設置它時沒有對它進行解析。因此,將任何標記(如作為實體參考而被識別的語法)視為文字值文本,並且需要在寫出時由實作適當轉義。為了分派包含實體參考的屬性值,使用者必須創建一個 Attr 節點,加上所有 TextEntityReference 節點,建構適當的子階層樹,並將它作為屬性值,通過 setAttributeNode 方法來分派。
要設置具有限定名稱和名稱空間 URI 的屬性,使用 setAttributeNS 方法。

指定者:
介面 Element 中的 setAttribute
參數:
name - 要創建或更改的屬性名稱。
value - 以字元串形式設置的值。

setAttributeNS

public void setAttributeNS(String namespaceURI,
                           String qualifiedName,
                           String value)
等效於 setAttribute(qualifiedName, value)

指定者:
介面 Element 中的 setAttributeNS
參數:
namespaceURI - 要創建或更改的屬性的名稱空間 URI。
qualifiedName - 要創建或更改的屬性的限定名稱。
value - 以字元串形式設置的值。
另請參見:
getAttributeNS(java.lang.String, java.lang.String)

removeAttribute

public void removeAttribute(String name)
從介面 Element 複製的描述
通過名稱移除一個屬性。如果被移除屬性的預設值在 DTD 中定義,則新的屬性值將在可用時隨該預設值以及相應名稱空間 URI、本地名稱和前綴立即出現。類似地,實作可以處理其他網要的預設值,但應用程序應該使用 Document.normalizeDocument() 來保證此資訊最新。
如果找不到具有此名稱的屬性,則此方法無效。
要通過本地名稱和名稱空間 URI 移除屬性,使用 removeAttributeNS 方法。

指定者:
介面 Element 中的 removeAttribute
參數:
name - 要移除的屬性的名稱。

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)
等效於 removeAttribute(localName)

指定者:
介面 Element 中的 removeAttributeNS
參數:
namespaceURI - 要移除的屬性的名稱空間 URI。
localName - 要移除的屬性的本地名稱。

getAttributeNode

public Attr getAttributeNode(String name)
從介面 Element 複製的描述
通過名稱獲得屬性節點。
要通過限定名稱和名稱空間 URI 獲得屬性節點,使用 getAttributeNodeNS 方法。

指定者:
介面 Element 中的 getAttributeNode
參數:
name - 要獲得的屬性名稱 (nodeName)。
返回:
返回具有指定名稱 (nodeName) 的 Attr 節點;如果沒有這樣的屬性,則返回 null

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)
等效於 getAttributeNode(localName)

指定者:
介面 Element 中的 getAttributeNodeNS
參數:
namespaceURI - 要獲得的屬性的名稱空間 URI。
localName - 要獲得的屬性的本地名稱。
返回:
具有特定屬性名稱和名稱空間 URI 的 Attr 節點;如果沒有這樣的屬性,則返回 null
另請參見:
setAttributeNodeNS(org.w3c.dom.Attr)

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
                      throws DOMException
從介面 Element 複製的描述
添加新的屬性節點。如果具有該名稱 (nodeName) 的屬性已經出現在元素中,則用新屬性替換它。用自身替換屬性節點無效。
要添加具有限定名稱和名稱空間 URI 的新屬性節點,使用 setAttributeNodeNS 方法。

指定者:
介面 Element 中的 setAttributeNode
參數:
newAttr - 要添加到屬性列表的 Attr 節點。
返回:
如果用 newAttr 屬性替換現有屬性,則返回被替換的 Attr 節點;否則返回 null
拋出:
DOMException - WRONG_DOCUMENT_ERR: 如果 newAttr 是從不同的文檔創建的,不是從創建該元素的文檔創建的,則引發此異常。
NO_MODIFICATION_ALLOWED_ERR: 如果此節點為只讀的,則引發此異常。
INUSE_ATTRIBUTE_ERR: 如果 newAttr 已經是另一個 Element 物件的屬性,則引發此異常。DOM 使用者必須顯式地複製 Attr 節點,以便在其他元素中重新使用它們。

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
等效於 setAttributeNode(newAttr)

指定者:
介面 Element 中的 setAttributeNodeNS
參數:
newAttr - 要添加到屬性列表的 Attr 節點。
返回:
如果用 newAttr 屬性替換具有相同本地名稱和名稱空間 URI 的現有屬性,則返回被替換的 Attr 節點;否則返回 null
另請參見:
getAttributeNodeNS(java.lang.String, java.lang.String)

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)
從介面 Element 複製的描述
移除指定的屬性節點。如果在 DTD 中定義了被移除 Attr 節點的預設值,則新的節點將在可用時隨該預設值以及相應名稱空間 URI、本地名稱和前綴一起立即出現。類似地,實作可以處理其他網要的預設值,但應用程序應該使用 Document.normalizeDocument() 來保證此資訊最新。

指定者:
介面 Element 中的 removeAttributeNode
參數:
oldAttr - 從屬性列表中移除的 Attr 節點。
返回:
被移除的 Attr 節點。

getElementsByTagName

public NodeList getElementsByTagName(String name)
從介面 Element 複製的描述
以文檔順序返回具有給定標記名稱的所有後代 ElementsNodeList

指定者:
介面 Element 中的 getElementsByTagName
參數:
name - 要比對的標記的名稱。特殊值 "*" 比對所有標記。
返回:
比對的 Element 節點列表。

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)
等效於 getElementsByTagName(localName)

指定者:
介面 Element 中的 getElementsByTagNameNS
參數:
namespaceURI - 要比對的元素的名稱空間 URI。特殊值 "*" 比對所有名稱空間。
localName - 要比對的元素的本地名稱。特殊值 "*" 比對所有本地名稱。
返回:
包含所有比對的 Elements 的新 NodeList 物件。

hasAttributes

public boolean hasAttributes()
從介面 Node 複製的描述
返回此節點(如果它是一個元素)是否具有任何屬性。

指定者:
介面 Node 中的 hasAttributes
返回:
如果此節點具有任何屬性,則返回 true;否則返回 false

hasAttribute

public boolean hasAttribute(String name)
從介面 Element 複製的描述
當具有給定名稱的屬性在此元素上被指定一個值或具有預設值時,返回 true;否則返回 false

指定者:
介面 Element 中的 hasAttribute
參數:
name - 要尋找的屬性名稱。
返回:
如果具有給定名稱的屬性在此元素上被指定一個值或具有預設值,則返回 true;否則返回 false

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String localName)
等效於 hasAttribute(localName)

指定者:
介面 Element 中的 hasAttributeNS
參數:
namespaceURI - 要尋找的屬性的名稱空間 URI。
localName - 要尋找的屬性的本地名稱。
返回:
如果具有給定本地名稱和名稱空間 URI 的屬性在此元素上被指定一個值或具有預設值,則返回 true;否則返回 false

getLength

public int getLength()
從介面 NodeList 複製的描述
列表中的節點數。有效子節點索引的範圍是 0 到 length-1(包含此值)。

指定者:
介面 NodeList 中的 getLength

item

public Node item(int index)
從介面 NodeList 複製的描述
返回集合中的第 index 個項。如果 index 大於或等於此列表中的節點數,則返回 null

指定者:
介面 NodeList 中的 item
參數:
index - 集合中的索引。
返回:
返回該 NodeListindex 位置處的節點;如果索引是無效索引,則返回 null

getUserObject

public Object getUserObject()
返回與此節點關聯的 Object 值。

返回:
使用者 Object
另請參見:
setUserObject(java.lang.Object)

setUserObject

public void setUserObject(Object userObject)
設置與此節點關聯的值。

參數:
userObject - 使用者 Object
另請參見:
getUserObject()

setIdAttribute

public void setIdAttribute(String name,
                           boolean isId)
                    throws DOMException
從介面 Element 複製的描述
如果參數 isIdtrue,則此方法將指定的屬性宣告為用於確定使用者的 ID 屬性。此方法影響 Attr.isId 的值和 Document.getElementById 的行為,但不更改可能正在使用的任何網要;需要特別指出的是,此方法不影響指定 Attr 節點的 Attr.schemaTypeInfo。使用參數 isId 的值 false 來取消將屬性宣告為使用者確定的 ID 屬性。
要通過本地名稱和名稱空間 URI 指定屬性,使用 setIdAttributeNS 方法。

指定者:
介面 Element 中的 setIdAttribute
參數:
name - 屬性名稱。
isId - 屬性是否是 ID 型別。
拋出:
DOMException - NO_MODIFICATION_ALLOWED_ERR:如果此節點為只讀的,則引發此異常。
NOT_FOUND_ERR:如果指定的節點不是此元素的屬性,則引發此異常。

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
                             String localName,
                             boolean isId)
                      throws DOMException
從介面 Element 複製的描述
如果參數 isIdtrue,則此方法將指定的屬性宣告為使用者確定的 ID 屬性。此方法影響 Attr.isId 的值和 Document.getElementById 的行為,但不更改可能正在使用的任何網要;需要特別指出的是,此方法不影響指定 Attr 節點的 Attr.schemaTypeInfo。使用參數 isId 的值 false 來取消將屬性宣告為使用者確定的 ID 屬性。

指定者:
介面 Element 中的 setIdAttributeNS
參數:
namespaceURI - 屬性的名稱空間 URI。
isId - 屬性是否是 ID 型別。
拋出:
DOMException - NO_MODIFICATION_ALLOWED_ERR:如果此節點為只讀的,則引發此異常。
NOT_FOUND_ERR: 如果指定的節點不是此元素的屬性,則引發此異常。

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
                               boolean isId)
                        throws DOMException
從介面 Element 複製的描述
如果參數 isIdtrue,則此方法將指定的屬性宣告為使用者確定的 ID 屬性。此方法影響 Attr.isId 的值和 Document.getElementById 的行為,但不更改可能正在使用的任何網要;需要特別指出的是,此方法不影響指定 Attr 節點的 Attr.schemaTypeInfo。使用參數 isId 的值 false 來取消將屬性宣告為使用者確定的 ID 屬性。

指定者:
介面 Element 中的 setIdAttributeNode
參數:
idAttr - 屬性節點。
isId - 屬性是否是 ID 型別。
拋出:
DOMException - NO_MODIFICATION_ALLOWED_ERR: 如果此節點為只讀的,則引發此異常。
NOT_FOUND_ERR: 如果指定的節點不是此元素的屬性,則引發此異常。

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()
從介面 Element 複製的描述
與此元素相關的型別資訊。

指定者:
介面 Element 中的 getSchemaTypeInfo

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)
從介面 Node 複製的描述
將對象與此節點上的鍵相關聯。該物件以後可以通過使用相同鍵的調用 getUserData 從此節點檢索到。

指定者:
介面 Node 中的 setUserData
參數:
key - 將該物件與其關聯的鍵。
data - 與給定鍵相關聯的物件;為 null 時表示移除與任何現有的與該鍵的關聯。
handler - 與該鍵關聯的處理程序,或 null
返回:
返回以前與此節點上的給定鍵關聯的 DOMUserData;如果沒有,則返回 null

getUserData

public Object getUserData(String key)
從介面 Node 複製的描述
檢索與此節點上的某個鍵相關聯的物件。必須首先通過使用相同鍵的調用 setUserData 將該物件設置到此節點。

指定者:
介面 Node 中的 getUserData
參數:
key - 該物件所關聯的鍵。
返回:
返回與此節點上的給定鍵關聯的 DOMUserData;如果沒有,則返回 null

getFeature

public Object getFeature(String feature,
                         String version)
從介面 Node 複製的描述
此方法返回一個特定的物件,該物件實作指定功能或版本的特定 API,如下所述。該特殊對象也可以通過使用特定於綁定的強制轉換方法獲得,但不是必須期望這樣,如文中討論的那樣。此方法還允許實作提供不支持 Node 介面的特殊物件。

指定者:
介面 Node 中的 getFeature
參數:
feature - 所請求的功能的名稱。注意,追加到功能名稱的任何加號 "+" 將被忽略,因為它在此方法的上下文中無關緊要。
version - 這是要測試的功能版本號。
返回:
返回實作指定功能和版本的特定 API 的物件(如果有);如果不存在實作與該功能相關的介面的物件,則返回 null。如果此方法返回的 DOMObject 實作 Node 介面,則它必須委託給主要核心 Node 且不返回與主要核心 Node 不一致的結果,如屬性、子節點,等等。

isSameNode

public boolean isSameNode(Node node)
從介面 Node 複製的描述
返回此節點是否是與給定節點相同的節點。
此方法提供一種方法來確定由實作返回的兩個 Node 參考是否參考同一個物件。當兩個 Node 參考參考同一個物件時,即使是通過代理,也可能完全可交換地使用這些參考,例如所有屬性都有相同的值且在任何參考上調用同一個 DOM 方法總是起完全相同的作用。

指定者:
介面 Node 中的 isSameNode
參數:
node - 要測試的節點。
返回:
如果節點相同,則返回 true;否則,返回 false

isEqualNode

public boolean isEqualNode(Node node)
從介面 Node 複製的描述
測試兩個節點是否相等。
此方法測試節點的相等性,不是測試是否相同(即兩個節點是否為對同一物件的參考),相同性可以使用 Node.isSameNode() 測試。所有相同的節點也將相等,儘管反之則不然。
當且僅當滿足以下條件時,兩個節點才相等:
兩個 DocumentType 節點要是相等,還必須滿足以下條件:
另一方面,以下內容不影響相等性:ownerDocumentbaseURIparentNode 屬性;Attr 節點的 specified 屬性;AttrElement 節點的 schemaTypeInfo 屬性;Text 節點的 Text.isElementContentWhitespace 屬性;以及在節點上註冊的任何使用者資料和事件偵聽器。

註:通常,在相等性檢查的考慮中,上面描述中未提到的任何情況都是無關緊要的。注意,此規範的未來版本可能考慮更多屬性,並且期望遵守此規範的實作進行相應的更新。

指定者:
介面 Node 中的 isEqualNode
參數:
node - 與其比較相等性的節點。
返回:
如果節點相等,則返回 true;否則,返回 false

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)
從介面 Node 複製的描述
從此節點開始,尋找與給定前綴相關的名稱空間 URI。
有關此方法使用的演算法的詳細資訊,請參見。

指定者:
介面 Node 中的 lookupNamespaceURI
參數:
prefix - 要尋找的前綴。如果此參數為 null,則此方法將返回預設的名稱空間 URI(如果有)。
返回:
返回相關的名稱空間 URI;如果未找到,則返回 null

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)
從介面 Node 複製的描述
此方法檢查指定的 namespaceURI 是否是預設名稱空間。

指定者:
介面 Node 中的 isDefaultNamespace
參數:
namespaceURI - 要尋找的名稱空間 URI。
返回:
如果指定的 namespaceURI 為預設名稱空間,則返回 true;否則,返回 false

lookupPrefix

public String lookupPrefix(String namespaceURI)
從介面 Node 複製的描述
從此節點開始,尋找與給定名稱空間 URI 相關的前綴。此方法忽略預設名稱空間宣告。
參見此方法使用的演算法的詳細資訊。

指定者:
介面 Node 中的 lookupPrefix
參數:
namespaceURI - 要尋找的名稱空間 URI。
返回:
如果已找到,則返回相關的名稱空間前綴;如果未找到任何前綴,則返回 null。如果一個以上的前綴與名稱空間前綴相關,則返回的名稱空間前綴與實作有關。

getTextContent

public String getTextContent()
                      throws DOMException
從介面 Node 複製的描述
此屬性返回此節點及其後代的文本內容。將它定義為 null 時,設置它無效。設置後,移除此節點可能有的任何可能的子節點,並且如果新字元串不為空或 null,則用包含此屬性設置的字元串的單個 Text 節點替換。
獲取後,不執行序列化,且返回的字元串不包含任何標記。不執行空白規範化且在元素內容中返回的字元串不包含空白(參見屬性 Text.isElementContentWhitespace)。類似地,設置後,也不執行解析,且以純文本內容形式採用輸入字元串。
根據下面定義的節點型別,返回的字元串由此節點的文本內容產生:
節點型別 內容
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE 串接每個子節點的 textContent 屬性值,不包括 COMMENT_NODE 和 PROCESSING_INSTRUCTION_NODE 節點。如果該節點沒有子節點,則這是空字元串。
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null

指定者:
介面 Node 中的 getTextContent
拋出:
DOMException - DOMSTRING_SIZE_ERR:在它返回的字元多於實作平臺上 DOMString 變數中適合的字元時引發此異常。

setTextContent

public void setTextContent(String textContent)
                    throws DOMException
從介面 Node 複製的描述
此屬性返回此節點及其後代的文本內容。將它定義為 null 時,設置它無效。設置後,移除此節點可能有的任何可能的子節點,並且,如果新字元串不為空或 null,則用包含此屬性設置的字元串的單個 Text 節點替換。
獲取後,不執行序列化,且返回的字元串不包含任何標記。不執行空白規範化,且返回的字元串在元素內容中不包含空白(參見屬性 Text.isElementContentWhitespace)。類似地,設置後,也不執行解析,且以純文本內容形式採用輸入字元串。
根據下面定義的節點型別,返回的字元串由此節點的文本內容產生:
節點型別 內容
ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE 串接每個子節點的 textContent 屬性值,不包括 COMMENT_NODE 和 PROCESSING_INSTRUCTION_NODE 節點。如果該節點沒有子節點,則這是空字元串。
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null

指定者:
介面 Node 中的 setTextContent
拋出:
DOMException - NO_MODIFICATION_ALLOWED_ERR: 節點為只讀的時引發此異常。

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException
從介面 Node 複製的描述
就節點在文檔中的位置並按照文檔的順序,比較參考節點(即在其上調用此方法的節點)與作為參數傳遞的節點。

指定者:
介面 Node 中的 compareDocumentPosition
參數:
other - 與參考節點比較的節點。
返回:
返回相對於參考節點如何定位節點。
拋出:
DOMException - NOT_SUPPORTED_ERR: 當被比較的節點來自不同的 DOM 實作,未調整該 DOM 實作以返回一致的特定於實作的結果時。

getBaseURI

public String getBaseURI()
從介面 Node 複製的描述
此節點的絕對基 URI;如果實作不能獲得絕對 URI,則為 null。此值如描述的那樣計算。但是,當 Document 支持功能 "HTML" [DOM Level 2 HTML] 時,首先使用 HTML BASE 元素(如果有)的 href 屬性的值計算基 URI;否則,使用 Document 介面中的 documentURI 屬性的值計算。

指定者:
介面 Node 中的 getBaseURI

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only