javax.swing.text
クラス PlainDocument

java.lang.Object
  |
  +--javax.swing.text.AbstractDocument
        |
        +--javax.swing.text.PlainDocument

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

Document, Serializable

public class PlainDocument

extends AbstractDocument

文字の属性をまったく保持しないプレーンなドキュメントです。デフォルトでは、このドキュメントの要素の構造は、テキスト内の行をマップしたものになります。getDefaultRootElement メソッドが返す Element は行のマップを表し、各子要素は単一の行を表します。このモデルは文字レベルの属性をまったく持ちませんが、それぞれの行には任意の属性セットによるタグを付けることができます。行からオフセット、およびオフセットから行への変換はデフォルトのルート要素を使って迅速に実行されます。編集によってトリガーされる DocumentEvent の構造についての情報は、行の構造の変更を示します。

デフォルトのコンテンツ記憶域管理は、ギャップ付きバッファの実装 (GapContent) によって行われます。GapContent は、かなり大きなドキュメントの編集をサポートしており、隣接するまとまった領域に対する一般的な編集を効率よく処理できます。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。

関連項目:

Document, AbstractDocument, 直列化された形式

クラス javax.swing.text.AbstractDocument から継承した内部クラス

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

フィールドの概要

static String	lineLimitAttribute 最大長がある場合、1 行の最大長を指定する属性の名前です。
static String	tabSizeAttribute コンテンツ内のタブのサイズを指定する属性の名前です。

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

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

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

StreamDescriptionProperty, TitleProperty

コンストラクタの概要

	PlainDocument() プレーンテキストドキュメントを構築します。
protected	PlainDocument(AbstractDocument.Content c) プレーンテキストドキュメントを構築します。

メソッドの概要

protected AbstractDocument.AbstractElement	createDefaultRoot() デフォルトのドキュメント構造を表すために使うルート要素を作成します。
Element	getDefaultRootElement() ドキュメントモデルのデフォルトのルート要素を返します。
Element	getParagraphElement(int pos) 指定された位置を保持する段落要素を返します。
protected void	insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr) ドキュメント構造をテキスト挿入の結果で更新します。
protected void	removeUpdate(AbstractDocument.DefaultDocumentEvent chng) ドキュメント構造をテキスト削除の結果で更新します。

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

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeDocumentListener, removeUndoableEditListener, render, setAsynchronousLoadPriority, setDocumentProperties, writeLock, writeUnlock

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

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

フィールドの詳細

tabSizeAttribute

public static final String tabSizeAttribute

コンテンツ内のタブのサイズを指定する属性の名前です。値の型は整数型です。

lineLimitAttribute

public static final String lineLimitAttribute

最大長がある場合、1 行の最大長を指定する属性の名前です。値の型は整数型です。

コンストラクタの詳細

PlainDocument

public PlainDocument()

プレーンテキストドキュメントを構築します。StringContent を使うデフォルトモデルが構築されて、設定されます。

PlainDocument

protected PlainDocument(AbstractDocument.Content c)

プレーンテキストドキュメントを構築します。デフォルトのルート要素が作成され、タブのサイズが 8 に設定されます。

パラメータ:

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

メソッドの詳細

getDefaultRootElement

public Element getDefaultRootElement()

ドキュメントモデルのデフォルトのルート要素を返します。

オーバーライド:

クラス AbstractDocument 内の getDefaultRootElement

戻り値:

ルート

関連項目:

Document.getDefaultRootElement()

createDefaultRoot

protected AbstractDocument.AbstractElement createDefaultRoot()

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

戻り値:

要素ベース

getParagraphElement

public Element getParagraphElement(int pos)

指定された位置を保持する段落要素を返します。このドキュメントは行をモデル化するだけなので、代わりに目的の行を返します。

オーバーライド:

クラス AbstractDocument 内の getParagraphElement

クラス javax.swing.text.AbstractDocument からコピーされたタグ:

パラメータ:

pos - オフセット開始 >= 0

戻り値:

要素

insertUpdate

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

ドキュメント構造をテキスト挿入の結果で更新します。これは、書き込みロック内で発生します。このドキュメントは行をマップするだけなので、ユーザが行マップを更新します。

オーバーライド:

クラス AbstractDocument 内の insertUpdate

パラメータ:

chng - 編集を記述する変更イベント

attr - 挿入テキストの属性セット

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

ドキュメント構造をテキスト削除の結果で更新します。これは、書き込みロック内で発生します。構造は行マップを表すので、削除のスパンが複数の行を占めているかどうかをチェックするだけです。削除のスパンが複数の行を占めている場合は、削除範囲を挟む前後の 2 行が結合されます。

オーバーライド:

クラス AbstractDocument 内の removeUpdate

パラメータ:

chng - 編集を記述する変更イベント