Interface Document

継承元:

Node

プロパティ:

doctype, documentElement, implementation

メソッド:

createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getElementById, getElementsByTagName, getElementsByTagNameNS, importNode

プロパティ:

• documentObject.doctype

  DocumentType型, 読取専用

  この文書に関連付けられた文書型宣言 (DocumentType 参照)。文書型宣言のないものについては、 HTML文書、XML文書ともに null を返す。 DOMレベル2 は文書型宣言の編集をサポートしない。 insertNode や removeNode のような Node インターフェイスを継承するメソッド使用を含め、どんな方法を使っても docType をの変更はできない。
  

• documentObject.documentElement

  Element型, 読取専用

  これは、文書のルート要素である子ノードに直にアクセスできるようした 簡便 プロパティである。HTML文書では、これは tagName が "HTML" の要素である。
  

• documentObject.implementation

  DOMImplementation型, 読取専用

  この文書を操作する DOMImplementation オブジェクト。DOM アプリケーションは複数の実装からオブジェクトを使用してよい。
  

メソッド:

• documentObject.createAttribute( name )

  与えられた名前の Attr を生成する。 Attr インスタンスは setAttributeNode メソッドを用いて Element 上に置くことが可能であることに注意。
  修飾名と名前空間URIを持つ属性の生成には、createAttributeNS メソッドを使用する。

  引数:

  name / DOMString

  属性の名前。
  

  戻り値:

  Attr 型。新しい Attr オブジェクトで、 nodeName プロパティは name に、また localName, prefix, namespaceURI は null に設定される。属性の値は空文字列である。

  例外:

  INVALID_CHARACTER_ERR / DOMException

  指定された名前に不正な文字が含まれている場合に発生。

• documentObject.createAttributeNS( namespaceURI, qualifiedName )

  与えられた修飾名と名前空間URIの属性を生成する。 HTML限定の実装はこのメソッドを実装する必要はない。

  引数:

  namespaceURI / DOMString

  生成する属性の 名前空間URI
  

  qualifiedName / DOMString

  インスタンス化する属性の 修飾名
  

  戻り値:

  Attr 型。Attr オブジェクトで、次に挙げるプロパティを持つ:

  Attribute	Value
  Node.nodeName	qualifiedName
  Node.namespaceURI	namespaceURI
  Node.prefix	接頭辞。これは qualifiedName から抽出される。接頭辞が存在しない場合は null
  Node.localName	qualifiedName から抽出される ローカル名
  Attr.name	qualifiedName
  Node.nodeValue	空文字列

  例外:

  INVALID_CHARACTER_ERR / DOMException

  指定された修飾名に不正な文字が含まれている場合に発生。

  NAMESPACE_ERR / DOMException

  qualifiedName が奇形(malformed)である場合、 qualifiedName が接頭辞を持ち namespaceURI が null である場合、 qualifiedName が接頭辞 "xml" を持つのに namespaceURI が "http://www.w3.org/XML/1998/namespace" ではない場合、 qualifiedName が "xmlns" であるが namespaceURI が "http://www.w3.org/2000/xmlns/" ではない場合に発生。

• documentObject.createCDATASection( data )

  指定された文字列を値に持つ CDATASection ノードを生成。

  引数:

  data / DOMString

  CDATASection の内容のためのデータ。
  

  戻り値:

  CDATASection 型。新しい CDATASection オブジェクト。

  例外:

  NOT_SUPPORTED_ERR / DOMException

  この文書がHTML文書である場合に発生。

• documentObject.createComment( data )

  指定された文字列を与えられた Comment を生成する。

  引数:

  data / DOMString

  ノードのためのデータ。
  

  戻り値:

  Comment 型。新しい Comment オブジェクト。

• documentObject.createDocumentFragment( )

  空の DocumentFragment オブジェクトを生成する。

  戻り値:

  DocumentFragment 型。新しい DocumentFragment。

• documentObject.createElement( tagName )

  指定した型の要素を生成する。 Note that 返されるインスタンスは Element インターフェイスを実装し、したがって返されるオブジェクト上に直接属性を指定可能であることに注意。
  加えて、デフォルト値を持つ既知の属性がある場合、それらを表す Attr ノードが自動生成され、その要素に据えられる。
  修飾名と名前空間URIを持つ要素の生成には、 createElementNS メソッドを用いる。

  引数:

  tagName / DOMString

  インスタンス化する要素型の名前。XMLでは、これは文字ケースを区別する。HTMLでは、 tagName パラメータは任意の文字ケースで提供されてよいが、DOM実装によって正統(canonical)大文字形式にマップされなければならない。
  

  戻り値:

  Element 型。新しい Element オブジェクトで、 nodeName プロパティは tagName に、 localName, prefix, namespaceURI は null に設定される。

  例外:

  INVALID_CHARACTER_ERR / DOMException

  指定された名前に不正な文字が含まれている場合に発生。

• documentObject.createElementNS( namespaceURI, qualifiedName )

  与えられた修飾名と名前空間URIをの要素を生成する。 HTML限定の実装はこのメソッドを実装する必要はない。

  引数:

  namespaceURI / DOMString

  生成する要素の 名前空間URI。
  

  qualifiedName / DOMString

  インスタンス化する要素型の 修飾名
  

  戻り値:

  Element 型。新しい Element オブジェクトで、次に挙げるプロパティを持つ:

  プロパティ	値
  Node.nodeName	qualifiedName
  Node.namespaceURI	namespaceURI
  Node.prefix	接頭辞。これは qualifiedName から抽出される。接頭辞が存在しない場合は null。
  Node.localName	ローカル名。これは qualifiedName から抽出される。
  Element.tagName	qualifiedName

  例外:

  INVALID_CHARACTER_ERR / DOMException

  指定された修飾名に不正な文字が含まれている場合に発生。

  NAMESPACE_ERR / DOMException

  qualifiedName が奇形(malformed)である場合、 qualifiedName が接頭辞を持ち namespaceURI が null である場合、 qualifiedName が接頭辞 "xml" を持つのに namespaceURI が "http://www.w3.org/XML/1998/namespace" [Namespaces] ではない場合に発生。

• documentObject.createEntityReference( name )

  EntityReference オブジェクトを生成する。更に、参照される実体が既知のものである場合、EntityReference ノードの子のリストが、該当する Entity ノードの子のリストと同じように作成される。

  Note: Entity ノードの子孫に結合されない 名前空間接頭辞 を持つものがある場合、生成された EntityReference ノードの該当する子孫も結合されない; (それの namespaceURI は null である)。 DOMレベル2 は名前空間接頭辞を解決するいかなる機構もサポートしない。

  引数:

  name / DOMString

  参照する実体の名前。
  

  戻り値:

  EntityReference 型。新しい EntityReference オブジェクト。

  例外:

  INVALID_CHARACTER_ERR / DOMException

  指定された名前に不正な文字が含まれている場合に発生。

  NOT_SUPPORTED_ERR / DOMException

  この文書がHTML文書である場合に発生。

• documentObject.createProcessingInstruction( target, data )

  与えられた名前とデータ文字列を持つ ProcessingInstruction ノードを生成する。

  引数:

  target / DOMString

  処理命令のターゲット部分。
  

  data / DOMString

  ノードのためのデータ。
  

  戻り値:

  ProcessingInstruction 型。新しい ProcessingInstruction オブジェクト。

  例外:

  INVALID_CHARACTER_ERR / DOMException

  指定されたターゲットに不正な文字が含まれている場合に発生。

  NOT_SUPPORTED_ERR / DOMException

  この文書がHTML文書である場合に発生。

• documentObject.createTextNode( data )

  指定された文字列を与えられた Text ノードを生成する。

  引数:

  data / DOMString

  ノードのためのデータ。
  

  戻り値:

  Text 型。新しい Text オブジェクト。

• documentObject.getElementById( elementId )

  elementId によって ID を与えられた Element を返す。そのような要素が存在しない場合は null を返す。複数の要素がこの ID を持つ場合の振る舞いは定義しない。

  Note: DOM 実装は、ID 型の属性を示す情報を持たなければならない。名前が "ID" の属性は、そう定義されない限りは ID 型ではない。属性が ID 型か否か知らない実装は、 null を返すことを期待する。

  引数:

  elementId / DOMString

  要素のためのユニークな id の値。
  

  戻り値:

  Element 型。マッチする要素。

• documentObject.getElementsByTagName( tagname )

  Document ツリーの先行順トラバーサルにおける出現順に並んだ、与えられた名前を持つ Element 全ての NodeList を返す。

  引数:

  tagname / DOMString

  マッチさせるタグの名前。特殊な値 "*" は全てのタグにマッチする。
  

  戻り値:

  NodeList 型。新しい NodeList オブジェクトで、マッチした全ての Elements を内包する。

• documentObject.getElementsByTagNameNS( namespaceURI, localName )

  Document ツリーの先行順横断における出現順に並んだ、 ローカル名 と名前空間URIを持つ Elements 全ての NodeList を返す。

  引数:

  namespaceURI / DOMString

  マッチする要素の 名前空間URI 。特殊値 "*" は全ての名前空間にマッチする。
  

  localName / DOMString

  マッチする要素の ローカル名 特注値 "*" は全てのローカル名にマッチする。
  

  戻り値:

  NodeList 型。新しい NodeList オブジェクトで。マッチした Elements 全てを含む.

• documentObject.importNode( importedNode, deep )

  別文書からこの文書にノードをインポートする。返されるノードは親を持たない; (parentNode が null である)。ソースノードは元文書から変更されたり除去されたりしない; このメソッドはソースノードの新しい複製を作成する。
  全ノードについて、ノードのインポートはインポートする文書に所有されるノードオブジェクトを生成し、これはソースノードの nodeName, nodeType と一致するプロパティ値, 加えて名前空間の関連するプロパティ(prefix, localName, namespaceURI) を持つ。 Node 上の cloneNode 操作のように、ソースノードは変更されない。
  追加情報は nodeType に適切なように複製され、XMLまたはHTML のソース片を一方から他方へ複製する場合は期待する振る舞いの模倣を試み、XMLでは2個の文書は異なるDTDを持ってよいと認識する。次のリストに各ノード型についての仕様を述べる。

  ATTRIBUTE_NODE

  生成された Attr 上の ownerElement プロパティは null に、 specified フラグは true に設定される。ソースとなる Attr の 子孫 は再帰的にインポートされ、結果のノードは該当する下位ツリーを形成するように再構築される。
  deep パラメータは Attr ノードには影響がないことに注意; それらはインポート時に常に子を運んで来る。

  DOCUMENT_FRAGMENT_NODE

  deep オプションが true ならば、ソース要素の 子孫 は再帰的にインポートされ、結果のノードは該当する下位ツリーを形成するように再構築される。 そうでない場合は、これは単に空の DocumentFragment を生成する。

  DOCUMENT_NODE

  Document ノードのインポートはできない。

  DOCUMENT_TYPE_NODE

  DocumentType ノードのインポートはできない。

  ELEMENT_NODE

  ソース要素の 指定された 属性ノードがインポートされ、生成された Attr ノードは生成された Element ノードに添付される。 デフォルトの属性は複製され ず、だがインポートを行う文書がこの要素名にデフォルトの属性を定義する場合、それらは代入される。 importNode の deep パラメータが true ならば、ソース要素の 子孫 は再帰的にインポートされ、結果のノードは該当する下位ツリーを形成するように再構築される。

  ENTITY_NODE

  Entity ノードはインポート可能だが、DOMの現在のリリースでは DocumentType は読取専用である。 DocumentType へインポートされるノードの追加の可能性は、 DOMの将来のリリースへの追加のために熟考されるだろう.
  インポートにおいて、 publicId, systemId, notationName プロパティは複製される。 deep インポートが要求されるならば、ソース Entity の 子孫 は再帰的にインポートされ該当する下位ツリーを形成するべく再構築される。

  ENTITY_REFERENCE_NODE

  deep インポートの要求に関係なく EntityReference 自身のみが複製される。ソースと送り先文書で実体を異なる物として定義しているかもれないからである。インポートを行う文書がこの実体名を定義している場合、その値が割当てられる。

  NOTATION_NODE

  Notation ノードはインポート可能だが、DOMの現在のリリースにおいて DocumentType は読取専用である。 これらインポートされたノードを DocumentType に追加する可能性はDOMの将来のリリースへの追加のために熟考されるだろう。
  インポートにおいて、 publicId, systemId プロパティが複製される。
  これらは子を持たないので、 deep パラメータは Notation ノー土壌に何の影響も値ないことに注意。

  PROCESSING_INSTRUCTION_NODE

  インポートされたノードはその target と data の値をそのソースノードから複製する。

  TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE

  CharacterData を継承するこれら三つのノード型は、 data, length プロパティをソースノードから複製する。

  引数:

  importedNode / Node

  インポートするノード。
  

  deep / boolean

  上述のように、 true ならば、指定されたノード以下の下位ツリーを再帰的にインポートする; false ならば、そのノード自身だけをインポートする。 Attr, EntityReference, Notation ノード上では何の影響もない。
  

  戻り値:

  Node 型。この Document に所属するインポートされたノード。

  例外:

  NOT_SUPPORTED_ERR / DOMException

  インポートされるノードの型が未サポートである場合に発生。

IDL 定義:

interface Document : Node {
  readonly attribute DocumentType     doctype;
  readonly attribute DOMImplementation  implementation;
  readonly attribute Element          documentElement;
  Element            createElement(in DOMString tagName)
                                        raises(DOMException);
  DocumentFragment   createDocumentFragment();
  Text               createTextNode(in DOMString data);
  Comment            createComment(in DOMString data);
  CDATASection       createCDATASection(in DOMString data)
                                        raises(DOMException);
  ProcessingInstruction createProcessingInstruction(in DOMString target,
                                                    in DOMString data)
                                        raises(DOMException);
  Attr               createAttribute(in DOMString name)
                                        raises(DOMException);
  EntityReference    createEntityReference(in DOMString name)
                                        raises(DOMException);
  NodeList           getElementsByTagName(in DOMString tagname);
  // Introduced in DOM Level 2:
  Node               importNode(in Node importedNode,
                                in boolean deep)
                                        raises(DOMException);
  // Introduced in DOM Level 2:
  Element            createElementNS(in DOMString namespaceURI,
                                     in DOMString qualifiedName)
                                        raises(DOMException);
  // Introduced in DOM Level 2:
  Attr               createAttributeNS(in DOMString namespaceURI,
                                       in DOMString qualifiedName)
                                        raises(DOMException);
  // Introduced in DOM Level 2:
  NodeList           getElementsByTagNameNS(in DOMString namespaceURI,
                                            in DOMString localName);
  // Introduced in DOM Level 2:
  Element            getElementById(in DOMString elementId);
};

• Back to Document Object Model Core
• Object Index
• Glossary
• References