javax.swing.text.html
クラス HTMLDocument

java.lang.Object
  javax.swing.text.AbstractDocument
      javax.swing.text.DefaultStyledDocument
          javax.swing.text.html.HTMLDocument

すべての実装されたインタフェース:

Serializable, Document, StyledDocument

public class HTMLDocument
extends DefaultStyledDocument

HTML をモデル化するドキュメントです。このモデルの目的は、ドキュメントのブラウズと編集の両方をサポートすることです。このため、HTML ドキュメントによって記述された構造は、デフォルトでは正確に複製されません。デフォルトでモデル化される要素構造は、HTMLDocument.HTMLReader クラスによって構築されます。 このクラスは、パーサーに必要な HTMLEditorKit.ParserCallback プロトコルを実装しています。構造を変更するには、HTMLReader クラスをサブクラス化し、getReader(int) メソッドを実装し直して新しいリーダーの実装を返すようにします。生成されるデフォルトの構造については、HTMLReader のマニュアルを参照してください。デフォルトの構造は、ドキュメントの内容が損なわれないことを意図して実装されていますが、HTML 形式を生成し直すときに異なった形式になることもあります。

このドキュメントは、HTML だけをモデル化しており、ビューの属性はドキュメント内に格納されません。要素は、StyleContext.NameAttribute 属性によって識別されます。 この属性は必ず、要素の種類を識別する HTML.Tag 型の値を持っています。コメントのように、合成される要素もあります。HTMLFactory はこの属性を使って構築するビューの種類を決定します。

このドキュメントは、追加読み込みをサポートしています。TokenThreshold プロパティーにより、どれくらいの量の解析がバッファーに格納されるとドキュメントの要素構造の更新を行うかを制御します。このプロパティーは、EditorKit で設定されるため、サブクラスから無効にすることができます。

Base プロパティーは、相対 URL をどの URL に解決するかを決定します。プロパティーの値が URL の場合、デフォルトでは、Base プロパティーは、Document.StreamDescriptionProperty になります。<BASE> タグが検出された場合、ベースは、そのタグで指定された URL になります。ベース URL はプロパティーなので、直接設定できます。

このドキュメントで使用するデフォルトのコンテンツ記憶機構は、ギャップバッファー (GapContent) です。別の機構を指定するには、Content の実装を引数に取るコンストラクタを使います。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。JDK Version 1.4 以降、すべての JavaBeans^™ の長期間の運用サポートは、java.beans パッケージに追加されています。詳細は、XMLEncoder を参照してください。

入れ子のクラスの概要

class	HTMLDocument.BlockElement HTML の構造ブロックを表す要素です。
class	HTMLDocument.HTMLReader HTML ドキュメントを HTML 要素構造とともにロードするための HTML リーダーです。
static class	HTMLDocument.Iterator 特定のタイプのタグに対して繰り返し処理を実行する反復子です。
class	HTMLDocument.RunElement HTML 文字レベル属性のセットが割り当てられているテキストのチャンクを表す要素です。

クラス javax.swing.text.DefaultStyledDocument から継承された入れ子のクラス/インタフェース

DefaultStyledDocument.AttributeUndoableEdit, DefaultStyledDocument.ElementBuffer, DefaultStyledDocument.ElementSpec, DefaultStyledDocument.SectionElement

クラス javax.swing.text.AbstractDocument から継承された入れ子のクラス/インタフェース

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

フィールドの概要

static String

AdditionalComments ドキュメントプロパティーのキーの値です。

クラス javax.swing.text.DefaultStyledDocument から継承されたフィールド

buffer, BUFFER_SIZE_DEFAULT

クラス javax.swing.text.AbstractDocument から継承されたフィールド

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

インタフェース javax.swing.text.Document から継承されたフィールド

StreamDescriptionProperty, TitleProperty

コンストラクタの概要

HTMLDocument()
デフォルトのバッファーサイズとデフォルトの StyleSheet を使用して HTML ドキュメントを構築します。

HTMLDocument(AbstractDocument.Content c, StyleSheet styles)
指定されたコンテンツ記憶域の実装と、指定されたスタイル/属性記憶機構とを使って HTML ドキュメントを作成します。

HTMLDocument(StyleSheet styles)
デフォルトのコンテンツ記憶域の実装と指定したスタイル/属性記憶域機構を使用して HTML ドキュメントを構築します。

メソッドの概要

protected void	create(DefaultStyledDocument.ElementSpec[] data) ドキュメントのコンテンツを、指定された要素仕様に置換します。
protected Element	createBranchElement(Element parent, AttributeSet a) ドキュメントの枝の要素を作成します。
protected AbstractDocument.AbstractElement	createDefaultRoot() デフォルトのドキュメント構造を表すために使うルート要素を作成します。
protected Element	createLeafElement(Element parent, AttributeSet a, int p0, int p1) テキストを直接表す (子を持たない) ドキュメントの葉の要素を作成します。
protected void	fireChangedUpdate(DocumentEvent e) 通知の配信対象を、指定されたイベント型で登録したすべてのリスナーに通知します。
protected void	fireUndoableEditUpdate(UndoableEditEvent e) 通知の配信対象を、指定されたイベント型で登録したすべてのリスナーに通知します。
URL	getBase() 相対 URL を解決処理する位置を返します。
Element	getElement(Element e, Object attribute, Object value) 属性 (値 value を持つ attribute) を格納する e の子要素を返します。
Element	getElement(String id) 指定した id Attribute を持つ要素を返します。
HTMLDocument.Iterator	getIterator(HTML.Tag t) 指定した HTML タグの反復子を取得します。
HTMLEditorKit.Parser	getParser() 既存のドキュメントに html を挿入するときに使用するパーサーを返します。
boolean	getPreservesUnknownTags() 未知のタグが見つかったときにパーサーの監視する動作を返します。
HTMLEditorKit.ParserCallback	getReader(int pos) パーサーが HTML ドキュメントをロードするときに使うリーダーを取得します。
HTMLEditorKit.ParserCallback	getReader(int pos, int popDepth, int pushDepth, HTML.Tag insertTag) パーサーが HTML ドキュメントをロードするために使うリーダーを返します。
StyleSheet	getStyleSheet() HTML ドキュメント自体が指定するドキュメント固有の表示規則 (CSS) を持つ、StyleSheet を取得します。
int	getTokenThreshold() ドキュメントの要素構造の更新前に、バッファーに格納されるトークンの数を取得します。
protected void	insert(int offset, DefaultStyledDocument.ElementSpec[] data) 新しい要素を一括して挿入します。
void	insertAfterEnd(Element elem, String htmlText) 指定要素が終了後に文字列として指定された HTML を挿入します。
void	insertAfterStart(Element elem, String htmlText) 要素の開始位置に文字列として指定された HTML を挿入します。
void	insertBeforeEnd(Element elem, String htmlText) 要素の終了位置に文字列として指定された HTML を挿入します。
void	insertBeforeStart(Element elem, String htmlText) 指定された要素が開始される前に文字列として指定された HTML を挿入します。
protected void	insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr) ドキュメント構造をテキスト挿入の結果で更新します。
void	processHTMLFrameHyperlinkEvent(HTMLFrameHyperlinkEvent e) HTML フレーム内でドキュメントによって生成された HyperlinkEvent の処理をします。
void	setBase(URL u) 相対 URL を解決処理する位置を設定します。
void	setInnerHTML(Element elem, String htmlText) 指定された要素の子を HTML 文字列として指定されたコンテンツと置き換えます。
void	setOuterHTML(Element elem, String htmlText) 指定された親の要素を HTML 文字列として指定されたコンテンツと置き換えます。
void	setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace) 段落に属性を設定します。
void	setParser(HTMLEditorKit.Parser parser) 既存のドキュメントに setInnerHTML や setOuterHTML などの html を挿入するときにメソッドが使用するパーサーを設定します。
void	setPreservesUnknownTags(boolean preservesTags) パーサーによる未知のタグの処理方法を判定します。
void	setTokenThreshold(int n) ドキュメントの要素構造の更新前に、バッファーに格納されるトークンの数を設定します。

クラス javax.swing.text.DefaultStyledDocument から継承されたメソッド

addDocumentListener, addStyle, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, getStyleNames, removeDocumentListener, removeStyle, removeUpdate, setCharacterAttributes, setLogicalStyle, styleChanged

クラス javax.swing.text.AbstractDocument から継承されたメソッド

addUndoableEditListener, createPosition, dump, fireInsertUpdate, fireRemoveUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

クラス java.lang.Object から継承されたメソッド

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

インタフェース javax.swing.text.Document から継承されたメソッド

addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render

フィールドの詳細

AdditionalComments

public static final String AdditionalComments

ドキュメントプロパティーのキーの値です。キーに対応する値は、String の Vector になります。 この文字列は、本文にはないコメントです。

関連項目:

定数フィールド値

コンストラクタの詳細

HTMLDocument

public HTMLDocument()

デフォルトのバッファーサイズとデフォルトの StyleSheet を使用して HTML ドキュメントを構築します。これは、コンストラクタ HTMLDocument(Content, StyleSheet) の簡易メソッドです。

HTMLDocument

public HTMLDocument(StyleSheet styles)

デフォルトのコンテンツ記憶域の実装と指定したスタイル/属性記憶域機構を使用して HTML ドキュメントを構築します。これは、コンストラクタ HTMLDocument(Content, StyleSheet) の簡易メソッドです。

パラメータ:

styles - スタイル

HTMLDocument

public HTMLDocument(AbstractDocument.Content c,
                    StyleSheet styles)

指定されたコンテンツ記憶域の実装と、指定されたスタイル/属性記憶機構とを使って HTML ドキュメントを作成します。

パラメータ:

c - コンテンツのコンテナ

styles - スタイル

メソッドの詳細

getReader

public HTMLEditorKit.ParserCallback getReader(int pos)

パーサーが HTML ドキュメントをロードするときに使うリーダーを取得します。このメソッドは HTMLDocument.HTMLReader のインスタンスを返すために実装されます。サブクラスは、必要であれば、カスタムタグや文字スタイル要素の構造的表現の処理などのために、このメソッドを再実装してドキュメントの構造化手段を変更できます。

パラメータ:

pos - 開始位置

戻り値:

パーサーがドキュメントをロードするために使うリーダー

getReader

public HTMLEditorKit.ParserCallback getReader(int pos,
                                              int popDepth,
                                              int pushDepth,
                                              HTML.Tag insertTag)

パーサーが HTML ドキュメントをロードするために使うリーダーを返します。このメソッドは HTMLDocument.HTMLReader のインスタンスを返すために実装されます。サブクラスは、必要であれば、カスタムタグや文字スタイル要素の構造的表現の処理などのために、このメソッドを再実装してドキュメントの構造化手段を変更できます。

これは、getReader(int, int, int, HTML.Tag, TRUE) の簡易メソッドです。

パラメータ:

popDepth - 挿入の前に生成される ElementSpec.EndTagTypes タグの数

pushDepth - 終了タグの生成後、挿入前に生成される ElementSpec.JoinNextDirection の方向を持つ ElementSpec.StartTagType のタグの数

insertTag - ドキュメントへの挿入を開始する最初のタグ

戻り値:

パーサーがドキュメントをロードするために使うリーダー

getBase

public URL getBase()

相対 URL を解決処理する位置を返します。デフォルトではこの位置は、ドキュメントが URL からロードされた場合にはドキュメントの URL になります。ベースタグが見つかり、解析できる場合には、それをベース位置として使用します。

戻り値:

ベース位置

setBase

public void setBase(URL u)

相対 URL を解決処理する位置を設定します。デフォルトではこの位置は、ドキュメントが URL からロードされた場合にはドキュメントの URL になります。ベースタグが見つかり、解析できる場合には、それをベース位置として使用します。

StyleSheet のベースを u とドキュメントのベースに設定します。

パラメータ:

u - 該当するベース URL

insert

protected void insert(int offset,
                      DefaultStyledDocument.ElementSpec[] data)
               throws BadLocationException

新しい要素を一括して挿入します。要素はこのようにしてドキュメント内に作成されます。解析によりどのような構造が必要であるかを決め、ドキュメントに書き込みロックがかかっていない間に、編集を記述するトークンのセットとして仕様を作成します。このメソッドは、リーダーによってまとめて呼び出されて、短時間の間書き込みロックを得ます。 ドキュメントへの実際の書き込みは、この時間に行われます。

オーバーライド:

クラス DefaultStyledDocument 内の insert

パラメータ:

offset - 開始オフセット

data - 要素データ

例外:

BadLocationException - 指定された位置が、関連するドキュメント内の 有効な位置を示さない場合

insertUpdate

protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
                            AttributeSet attr)

ドキュメント構造をテキスト挿入の結果で更新します。これは、書き込みロック内で発生します。この実装は、挿入されたコンテンツを単に改行ごとに構文解析し、要素バッファーに対する一連の指示を構築します。

オーバーライド:

クラス DefaultStyledDocument 内の insertUpdate

パラメータ:

chng - ドキュメント変更の説明

attr - 属性

create

protected void create(DefaultStyledDocument.ElementSpec[] data)

ドキュメントのコンテンツを、指定された要素仕様に置換します。このメソッドは、ロードがまとめて完了した場合、挿入の前に呼び出されます。ドキュメント全体を一度にまとめてロードする場合に呼び出される、唯一のメソッドです。

オーバーライド:

クラス DefaultStyledDocument 内の create

パラメータ:

data - ドキュメントの新しいコンテンツ

setParagraphAttributes

public void setParagraphAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)

段落に属性を設定します。

このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「How to Use Threads」を参照してください。

定義:

インタフェース StyledDocument 内の setParagraphAttributes

オーバーライド:

クラス DefaultStyledDocument 内の setParagraphAttributes

パラメータ:

offset - 段落に対するオフセット (最小でも 0 でなければならない)

length - 影響を受ける文字数 (最小でも 0 でなければならない)

s - 属性

replace - 既存の属性を置換するか、マージするか

getStyleSheet

public StyleSheet getStyleSheet()

HTML ドキュメント自体が指定するドキュメント固有の表示規則 (CSS) を持つ、StyleSheet を取得します。

戻り値:

StyleSheet

getIterator

public HTMLDocument.Iterator getIterator(HTML.Tag t)

指定した HTML タグの反復子を取得します。包含されているアンカーのセットでの繰り返し処理や、入力要素での繰り返し処理などで使用されます。

パラメータ:

t - 要求した HTML.Tag

戻り値:

指定した HTML タグの Iterator

関連項目:

HTML.Tag

createLeafElement

protected Element createLeafElement(Element parent,
                                    AttributeSet a,
                                    int p0,
                                    int p1)

テキストを直接表す (子を持たない) ドキュメントの葉の要素を作成します。HTMLDocument.RunElement 型の要素を返すために実装されます。

オーバーライド:

クラス AbstractDocument 内の createLeafElement

パラメータ:

parent - 親要素

a - 要素の属性

p0 - 範囲の始点 (最小でも 0 でなければならない)

p1 - 範囲の終点 (最小でも p0 でなければならない)

戻り値:

新規要素

createBranchElement

protected Element createBranchElement(Element parent,
                                      AttributeSet a)

ドキュメントの枝の要素を作成します。この要素には、ほかの要素 (複数可) を含めることができます。HTMLDocument.BlockElement 型の要素を返すために実装されます。

オーバーライド:

クラス AbstractDocument 内の createBranchElement

パラメータ:

parent - 親要素

a - 属性

戻り値:

要素

createDefaultRoot

protected AbstractDocument.AbstractElement createDefaultRoot()

デフォルトのドキュメント構造を表すために使うルート要素を作成します。

オーバーライド:

クラス DefaultStyledDocument 内の createDefaultRoot

戻り値:

要素ベース

setTokenThreshold

public void setTokenThreshold(int n)

ドキュメントの要素構造の更新前に、バッファーに格納されるトークンの数を設定します。

パラメータ:

n - バッファーされるトークンの数

getTokenThreshold

public int getTokenThreshold()

ドキュメントの要素構造の更新前に、バッファーに格納されるトークンの数を取得します。デフォルト値は、Integer.MAX_VALUE です。

戻り値:

バッファーされるトークンの数

setPreservesUnknownTags

public void setPreservesUnknownTags(boolean preservesTags)

パーサーによる未知のタグの処理方法を判定します。true を設定すると未知のタグはモデルに入れられ、そうでない場合はモデルから外されます。

パラメータ:

preservesTags - 未知のタグがモデルに保存される場合は true、そうでない場合、タグはモデルから外される

関連項目:

HTML.Tag

getPreservesUnknownTags

public boolean getPreservesUnknownTags()

未知のタグが見つかったときにパーサーの監視する動作を返します。

戻り値:

解析時に未知のタグが残される場合は true

関連項目:

HTML.Tag

processHTMLFrameHyperlinkEvent

public void processHTMLFrameHyperlinkEvent(HTMLFrameHyperlinkEvent e)

HTML フレーム内でドキュメントによって生成された HyperlinkEvent の処理をします。HyperlinkEvents タイプは、パラメータが示す通り、HTMLFrameHyperlinkEvent です。HyperlinkEvents に含まれる通常の情報のほかに、このイベントはクリックが発生したフレーム (発生元の要素) に対応する要素、およびターゲット名を格納しています。ターゲット名は次に示す 4 種類の値のどれかです。

• _self
• _parent
• _top
• 名前の付いたフレーム

ターゲットが _self の場合、HTML.Attribute.SRC の値を変更するアクションが発生し、ChangedUpdate イベントをトリガーします。

ターゲットが _parent の場合、<FRAMESET> 要素である親要素を削除し、新しい <FRAME> 要素を挿入したあと、HTML.Attribute.SRC 属性が送信先の URL と等しい値を持つように設定して RemovedUpdate および InsertUpdate をトリガーします。

ターゲットが _top の場合、このメソッドは何も処理を行いません。_top は、フレーム用のビューの実装 (具体的には FrameView) で処理されます。_top はドキュメント全体の置き換えを意味するため、置換対象ドキュメントの外部で処理してください。

ターゲットがフレーム名の場合、ターゲットと同じ名前の要素を要素階層から探し、その要素の HTML.Attribute.SRC 属性を更新して ChangedUpdate イベントをトリガーします。

パラメータ:

e - イベント

setParser

public void setParser(HTMLEditorKit.Parser parser)

既存のドキュメントに setInnerHTML や setOuterHTML などの html を挿入するときにメソッドが使用するパーサーを設定します。

HTMLEditorKit.createDefaultDocument はパーサーを設定します。手動で HTMLDocument ドキュメントを作成する場合は、それぞれに対応したパーサーを設定するようにしてください。

パラメータ:

parser - テキストの挿入に使われるパーサー

導入されたバージョン:

1.3

getParser

public HTMLEditorKit.Parser getParser()

既存のドキュメントに html を挿入するときに使用するパーサーを返します。

戻り値:

テキストの挿入に使われるパーサー

導入されたバージョン:

1.3

setInnerHTML

public void setInnerHTML(Element elem,
                         String htmlText)
                  throws BadLocationException,
                         IOException

指定された要素の子を HTML 文字列として指定されたコンテンツと置き換えます。

2 つ以上のイベントとして表示され、削除に続き n を挿入します。

正しく機能させるために、ドキュメントは HTMLEditorKit.Parser を用意する必要があります。これは、ドキュメントが HTMLEditorKit から createDefaultDocument メソッドにより生成された場合です。

パラメータ:

elem - 子が置き換えられる枝の要素

htmlText - 解析され、elem に割り当てられる文字列

例外:

IllegalArgumentException - elem が葉の場合

IllegalStateException - HTMLEditorKit.Parser が 未定義の場合

BadLocationException

IOException

導入されたバージョン:

1.3

setOuterHTML

public void setOuterHTML(Element elem,
                         String htmlText)
                  throws BadLocationException,
                         IOException

指定された親の要素を HTML 文字列として指定されたコンテンツと置き換えます。

2 つ以上のイベントとして表示され、削除に続き n を挿入します。

葉を置きかえるときには、改行が必要な場合に改行があるかどうかを確認してください。これで追加要素が挿入されます。<img> を持つ改行を含んだ文字要素を置き換えようとする場合は、一つはイメージ用、もう一つは改行用に 2 つの要素を生成することになります。 要素の長さを置き換えると、2 つの要素で終了します。

要素の長さを置き換えると、2 つの要素で終了します。つまり、setOuterHTML(getCharacterElement(getLength()), "blah") が最終的に 2 つの葉要素になります。一つは blah を表し、もう一つは末尾要素を表します。

正しく機能させるために、ドキュメントは HTMLEditorKit.Parser を用意する必要があります。これは、ドキュメントが HTMLEditorKit から createDefaultDocument メソッドにより生成された場合です。

パラメータ:

elem - 子が置き換えられる枝の要素

htmlText - 解析され、elem に割り当てられる文字列

例外:

IllegalStateException - HTMLEditorKit.Parser が設定されていない場合

BadLocationException

IOException

導入されたバージョン:

1.3

insertAfterStart

public void insertAfterStart(Element elem,
                             String htmlText)
                      throws BadLocationException,
                             IOException

要素の開始位置に文字列として指定された HTML を挿入します。

正しく機能させるために、ドキュメントは HTMLEditorKit.Parser を用意する必要があります。これは、ドキュメントが HTMLEditorKit から createDefaultDocument メソッドにより生成された場合です。

パラメータ:

elem - 新しいテキストのルートである枝の要素

htmlText - 解析され、elem に割り当てられる文字列

例外:

IllegalStateException - ドキュメントに HTMLEditorKit.Parser が 設定されていない場合

BadLocationException

IOException

導入されたバージョン:

1.3

insertBeforeEnd

public void insertBeforeEnd(Element elem,
                            String htmlText)
                     throws BadLocationException,
                            IOException

要素の終了位置に文字列として指定された HTML を挿入します。

elem の子が葉で、elem.getEndOffset() - 1 の文字が改行である場合、改行後にテキストがないようにするために改行前に挿入します。

正しく機能させるために、ドキュメントは HTMLEditorKit.Parser を用意する必要があります。これは、ドキュメントが HTMLEditorKit から createDefaultDocument メソッドにより生成された場合です。

パラメータ:

elem - 新しいテキストのルートである要素

htmlText - 解析され、elem に割り当てられる文字列

例外:

IllegalStateException - ドキュメントに HTMLEditorKit.Parser が 設定されていない場合

BadLocationException

IOException

導入されたバージョン:

1.3

insertBeforeStart

public void insertBeforeStart(Element elem,
                              String htmlText)
                       throws BadLocationException,
                              IOException

指定された要素が開始される前に文字列として指定された HTML を挿入します。

正しく機能させるために、ドキュメントは HTMLEditorKit.Parser を用意する必要があります。これは、ドキュメントが HTMLEditorKit から createDefaultDocument メソッドにより生成された場合です。

パラメータ:

elem - 新しいテキストのルートである要素

htmlText - 解析され、elem に割り当てられる文字列

例外:

IllegalStateException - ドキュメントに HTMLEditorKit.Parser が 設定されていない場合

BadLocationException

IOException

導入されたバージョン:

1.3

insertAfterEnd

public void insertAfterEnd(Element elem,
                           String htmlText)
                    throws BadLocationException,
                           IOException

指定要素が終了後に文字列として指定された HTML を挿入します。

正しく機能させるために、ドキュメントは HTMLEditorKit.Parser を用意する必要があります。これは、ドキュメントが HTMLEditorKit から createDefaultDocument メソッドにより生成された場合です。

パラメータ:

elem - 新しいテキストのルートである要素

htmlText - 解析され、elem に割り当てられる文字列

例外:

IllegalStateException - ドキュメントに HTMLEditorKit.Parser が 設定されていない場合

BadLocationException

IOException

導入されたバージョン:

1.3

getElement

public Element getElement(String id)

指定した id Attribute を持つ要素を返します。要素が見つからない場合は null が返されます。このメソッドは Attribute に対して働き、文字タグに対しては働きません。HTML の簡単な例 <a id="HelloThere"> において、属性は id、文字タグは a です。このメソッドは getElement(RootElement, HTML.Attribute.id, id) の簡易メソッドです。このメソッドはスレッドに対して安全ではありません。

パラメータ:

id - 目的の Attribute の文字列表現

戻り値:

指定された Attribute を持つ要素。見つからない場合、または id が null の場合は null

導入されたバージョン:

1.3

関連項目:

HTML.Attribute

getElement

public Element getElement(Element e,
                          Object attribute,
                          Object value)

属性 (値 value を持つ attribute) を格納する e の子要素を返します。見つからない場合は null を返します。このメソッドはスレッドに対して安全ではありません。

パラメータ:

e - 検索を開始するルート要素

attribute - 目的の Attribute

value - 指定した Attribute の値

戻り値:

指定された Attribute と 指定された value を持つ要素。見つからない場合は null

導入されたバージョン:

1.3

関連項目:

HTML.Attribute

fireChangedUpdate

protected void fireChangedUpdate(DocumentEvent e)

通知の配信対象を、指定されたイベント型で登録したすべてのリスナーに通知します。イベントインスタンスは、fire メソッドに渡されるパラメータを使って簡単に生成されます。

オーバーライド:

クラス AbstractDocument 内の fireChangedUpdate

パラメータ:

e - イベント

関連項目:

EventListenerList

fireUndoableEditUpdate

protected void fireUndoableEditUpdate(UndoableEditEvent e)

通知の配信対象を、指定されたイベント型で登録したすべてのリスナーに通知します。イベントインスタンスは、fire メソッドに渡されるパラメータを使って簡単に生成されます。

オーバーライド:

クラス AbstractDocument 内の fireUndoableEditUpdate

パラメータ:

e - イベント

関連項目:

EventListenerList