インタフェースHTMLDocument
public interface HTMLDocument extends Document
HTMLDocumentはHTML階層のルートであり、コンテンツ全体を保持します。 階層へのアクセスを提供するだけでなく、ドキュメントのある一連の情報へアクセスする簡単な方法を備えています。
alinkColor、background、bgColor、fgColor、linkColor、vlinkColorの各プロパティは推奨されなくなりました。かわりにBODY要素の対応するプロパティが推奨されます。DOMレベル2では、getElementByIdメソッドが移動し、Documentインタフェースから継承されます。
「Document Object Model (DOM) Level 2 Specification」も参照してください。
- 導入されたバージョン:
- 1.4、DOMレベル2
-
フィールドのサマリー
インタフェース 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修飾子と型フィールド説明static final shortノードはAttrです。static final shortノードはCDATASectionです。static final shortノードはCommentです。static final shortノードはDocumentFragmentです。static final shortノードはDocumentです。static final shortノードは参照ノードに含まれています。static final shortノードは参照ノードを含みます。static final short2つのノードは切断されます。static final shortノードは参照ノードのあとに続きます。static final short先行するかあとにくるかは実装に固有です。static final short2番目のノードは参照ノードの前にあります。static final shortノードはDocumentTypeです。static final shortノードはElementです。static final shortノードはEntityです。static final shortノードはEntityReferenceです。static final shortノードはNotationです。static final shortノードはProcessingInstructionです。static final shortノードはTextノードです。 -
メソッドのサマリー
修飾子と型メソッド説明voidclose()open()で開いたドキュメント・ストリームを閉じ、強制的に描画します。name属性の値が設定された、ドキュメント内にあるすべてのアンカー(A)要素のコレクション。ドキュメント内の、アプレットを含むすべてのOBJECT要素、およびすべてのAPPLET(非推奨)要素のコレクション。getBody()ドキュメントのコンテンツを含む要素。ドキュメントに関連付けられたcookie。ドキュメントを公開しているサーバーのドメイン名、あるいはサーバーがドメイン名で特定できない場合はnullを返します。getElementsByName(String elementName) name属性値がelementNameで指定される要素のコレクション(空の場合あり)を返します。getForms()ドキュメント内にあるすべてのフォームのコレクション。ドキュメント内にあるすべてのIMG要素のコレクション。getLinks()href属性の値が設定された、ドキュメント内にあるすべてのAREA要素とアンカー(A)要素のコレクション。このページにリンクしているページのURIを返します。getTitle()ドキュメントのヘッダー部にあるTITLE要素で指定したドキュメントのタイトル。getURL()ドキュメントの完全なURIです。voidopen()ノートvoidsetBody(HTMLElement body) voidvoidvoidopen()で開いたドキュメント・ストリームにテキスト文字列を書き込みます。voidopen()で開いたドキュメント・ストリームに、テキスト文字列を書き込み、そのあとに改行文字を書き込みます。インタフェースDocumentで宣言されたメソッド
adoptNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getInputEncoding, getStrictErrorChecking, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, normalizeDocument, renameNode, setDocumentURI, setStrictErrorChecking, setXmlStandalone, setXmlVersion修飾子と型メソッド説明ほかの文書のノードを現在の文書にインポートします。createAttribute(String name) 所定の名前のAttrを作成します。createAttributeNS(String namespaceURI, String qualifiedName) 所定の修飾名と名前空間URIを持つ属性を作成します。createCDATASection(String data) 指定された文字列を値として持つCDATASectionノードを作成します。createComment(String data) 指定された文字列を持つCommentノードを作成します。空のDocumentFragmentオブジェクトを作成します。createElement(String tagName) 指定された型の要素を作成します。createElementNS(String namespaceURI, String qualifiedName) 所定の修飾名と名前空間URIを持つ要素を作成します。createEntityReference(String name) EntityReferenceオブジェクトを作成します。createProcessingInstruction(String target, String data) 指定された名前およびデータ文字列を使用してProcessingInstructionノードを作成します。createTextNode(String data) 指定された文字列を持つTextノードを作成します。この文書に関連付けられている文書型宣言(DocumentTypeを参照)。文書の文書要素になっている子ノードへの直接アクセスを可能にする便利な属性です。ドキュメントの場所。未定義の場合やDOMImplementation.createDocumentを使ってDocumentが作成された場合はnull。Document.normalizeDocument()が呼び出されたときに使用される構成。getElementById(String elementId) 所定の値のID属性を持つElementを返します。getElementsByTagName(String tagname) 文書内の、特定のタグ名を持つすべてのElementsを文書の順に格納するNodeListを返します。getElementsByTagNameNS(String namespaceURI, String localName) 特定のローカル名と名前空間URIを持つすべてのElementsを文書の順に格納するNodeListを返します。この文書を処理するDOMImplementationオブジェクト。このドキュメントを解析するときに使用するエンコーディングを指定します。booleanエラー・チェックを適用するかどうかを指定します。この文書のエンコーディングをXML宣言の一部として指定する属性。booleanこのドキュメントがスタンドアロンかどうかをXML宣言の一部として指定します。この文書のバージョン番号をXML宣言の一部として指定します。importNode(Node importedNode, boolean deep) 別の文書から現在の文書へノードをインポートします。このとき、元の文書のソース・ノードが変更または削除されることはありません。このメソッドはソース・ノードの新しいコピーを作成します。voidこのメソッドは、文書を通常の形式に変換して、保存およびロードするように動作します。renameNode(Node n, String namespaceURI, String qualifiedName) ELEMENT_NODEまたはATTRIBUTE_NODE型の既存のノードを変更します。voidsetDocumentURI(String documentURI) ドキュメントの場所。未定義の場合やDOMImplementation.createDocumentを使ってDocumentが作成された場合はnull。voidsetStrictErrorChecking(boolean strictErrorChecking) エラー・チェックを適用するかどうかを指定します。voidsetXmlStandalone(boolean xmlStandalone) このドキュメントがスタンドアロンかどうかをXML宣言の一部として指定します。voidsetXmlVersion(String xmlVersion) この文書のバージョン番号をXML宣言の一部として指定します。インタフェースNodeで宣言されたメソッド
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData修飾子と型メソッド説明appendChild(Node newChild) ノードnewChildをこのノードの子のリストの末尾に追加します。cloneNode(boolean deep) ノードのジェネリック・コピー・コンストラクタとして、このノードの複製を返します。shortcompareDocumentPosition(Node other) このメソッドが呼び出されている参照ノードを、パラメータとして渡されるノードと、文書内の位置に関して文書順に比較します。このノードがElementの場合、このノードの属性を含むNamedNodeMap。それ以外の場合はnull。このノードの絶対ベースURI。実装が絶対URIを取得できなかった場合はnull。このノードの子をすべて含むNodeList。getFeature(String feature, String version) このメソッドは、指定した機能とバージョンを持つ特殊な形式のAPIを指定されたとおりに実装する特殊な形式のオブジェクトを返します。このノードの最初の子ノードです。このノードの最後の子ノードです。このノードの修飾名のローカル部分を返します。このノードの名前空間URI。未指定の場合はnull。このノードの直後のノードです。このノードの名前です。この名前は型によって異なります。上記の表を参照してください。shortオブジェクトの型を表すコードです。上記の定義を参照してください。このノードの値です。この値は型によって異なります。前述の表を参照してください。このノードに関連付けられたDocumentオブジェクト。このノードの親ノードです。このノードの名前空間接頭辞です。未指定の場合はnullになります。このノードの直前のノードです。この属性は、指定されたノードとノードの子孫のテキスト・コンテンツを返します。getUserData(String key) このノードのキーに関連付けられたオブジェクトを取得します。booleanこのノードが要素である場合、属性を持っているかどうかを判断します。booleanこのノードが子ノードを持っているかどうかを判断します。insertBefore(Node newChild, Node refChild) 既存のrefChild子ノードの前にnewChildノードを挿入します。booleanisDefaultNamespace(String namespaceURI) このメソッドは、指定されたnamespaceURIがデフォルトの名前空間であるかどうかをチェックします。booleanisEqualNode(Node arg) 2つのノードが等しいかどうかをテストします。booleanisSameNode(Node other) このノードが指定されたノードと同じノードであるかどうかを返します。booleanisSupported(String feature, String version) DOM実装が特定の機能を実装しており、このノードがその機能を指定されたとおりにサポートしているかどうかを判定します。lookupNamespaceURI(String prefix) 指定したノードから開始して、所定の接頭辞に関連する名前空間URIを検索します。lookupPrefix(String namespaceURI) 指定されたノードから開始して、所定の名前空間URIに関連する接頭辞を検索します。voidこのNodeのサブツリーの最深部までに存在するすべてのTextノード(属性ノードを含む)を、Textノードが構造(要素、コメント、処理命令、CDATAセクション、エンティティ参照など)のみによって分離される、「正規」形式にします。その結果、隣接するTextノードも空のTextノードも存在しない状態になります。removeChild(Node oldChild) 子リストからoldChildで示される子ノードを削除し、この子ノードを返します。replaceChild(Node newChild, Node oldChild) 子リストの中の子ノードoldChildをnewChildで置き換え、oldChildノードを返します。voidsetNodeValue(String nodeValue) このノードの値です。この値は型によって異なります。前述の表を参照してください。voidこのノードの名前空間接頭辞です。未指定の場合はnullになります。voidsetTextContent(String textContent) この属性は、指定されたノードとノードの子孫のテキスト・コンテンツを返します。setUserData(String key, Object data, UserDataHandler handler) このノードのキーにオブジェクトを関連付けます。
-
メソッドの詳細
-
getTitle
String getTitle()ドキュメントのヘッダー部にあるTITLE要素で指定したドキュメントのタイトル。 -
setTitle
void setTitle(String title) -
getReferrer
String getReferrer()このページにリンクしているページのURIを返します。 ユーザーがページに直接移動した場合(リンクではなくブックマークを使用した場合など)、この値は空の文字列です。 -
getDomain
String getDomain()ドキュメントを公開しているサーバーのドメイン名、あるいはサーバーがドメイン名で特定できない場合はnullを返します。 -
getURL
String getURL()ドキュメントの完全なURIです。 -
getBody
HTMLElement getBody()ドキュメントのコンテンツを含む要素。BODYコンテンツのあるドキュメントの場合、BODY要素を返します。 フレーム・セットのドキュメントの場合は、いちばん外側のFRAMESET要素を返します。 -
setBody
void setBody(HTMLElement body) -
getImages
HTMLCollection getImages()ドキュメント内にあるすべてのIMG要素のコレクション。 下位互換性のため、動作はIMG要素だけに制限されます。 -
getApplets
HTMLCollection getApplets()ドキュメント内の、アプレットを含むすべてのOBJECT要素、およびすべてのAPPLET(非推奨)要素のコレクション。 -
getLinks
HTMLCollection getLinks()href属性の値が設定された、ドキュメント内にあるすべてのAREA要素とアンカー(A)要素のコレクション。 -
getForms
HTMLCollection getForms()ドキュメント内にあるすべてのフォームのコレクション。 -
getAnchors
HTMLCollection getAnchors()name属性の値が設定された、ドキュメント内にあるすべてのアンカー(A)要素のコレクション。 ノート 下位互換性のため、返されるアンカーのセットにはname属性付きで作成されたアンカーのみが含まれ、id属性付きで作成されたアンカーは含まれません。 -
getCookie
String getCookie()ドキュメントに関連付けられたcookie。 存在しない場合、値は空の文字列になります。 それ以外の場合、値は、ページに関連付けられたすべてのクッキーについて、名前と値のペアをセミコロンで区切ったリストの文字列になります。 たとえば、name=value;expires=dateです。 -
setCookie
void setCookie(String cookie) -
open
void open()ノート このメソッドと次のメソッドでは、構文解析していないHTMLの文字列を使用するドキュメントの構造モデルを、追加したり置き換えたりすることができます。 このドキュメントの執筆時点では、HTMLとXMLの両方のドキュメントに対して類似した機能を提供する代替メソッドが考慮されています。 より一般的な目的のメカニズムを優先させるため、次のメソッドは、将来非推奨になるおそれがあります。
書き込むためにドキュメント・ストリームを開きます。 ドキュメントがターゲットに存在する場合は、このメソッドによってクリアされます。 -
close
void close()open()で開いたドキュメント・ストリームを閉じ、強制的に描画します。 -
write
void write(String text) open()で開いたドキュメント・ストリームにテキスト文字列を書き込みます。 テキストはドキュメント構造モデルへ構文解析されます。- パラメータ:
text- ドキュメント構造モデルの構造へ構文解析される文字列。
-
writeln
void writeln(String text) open()で開いたドキュメント・ストリームに、テキスト文字列を書き込み、そのあとに改行文字を書き込みます。 テキストはドキュメント構造モデルへ構文解析されます。- パラメータ:
text- ドキュメント構造モデルの構造へ構文解析される文字列。
-
getElementsByName
-