|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 内部クラス | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object | +--javax.swing.text.AbstractDocument
ドキュメントインタフェースの実装であり、各種のドキュメントを実装するときのベースになります。このレベルではポリシーがごくわずかなので、それに応じて使用が難しくなります。
このクラスは、ドキュメントのロック機構を実装します。この機構によって、複数の読み込みまたはひとつの書き込みを扱えるようになり、複数の書き込みがあっても、ドキュメントのオブザーバ全員に以前の変更が通知されるまで、ドキュメントに別の変更を加えることができません。読み込みロックの取得および解放には、render
メソッドを使います。書き込みロックは、ドキュメントを変更するメソッドによって取得され、そのメソッド呼び出しの間は保持されます。通知は、ドキュメントを変更するスレッド上で行われます。このスレッドは、通知の間はドキュメントへの完全な読み込みアクセス権を持っています。一方で、その他の書き込み側は、通知が完了するまではアクセスを許されません。通知は Beans イベント通知であり、すべてのリスナーが通知を受け取るまでは他の変更を許可しません。
このクラスからサブクラス化された任意のモデルで、BasicTextUI から派生した Look & Feel の実装を持つテキストコンポーネントと関連して使用されるものは、安全に非同期に更新されます。これは、ドキュメントのタイプが AbstractDocument
の場合には、View 階層へのすべてのアクセスが BasicTextUI によって直列化されるからです。ロック機構では、独立したスレッドの View 階層へのアクセスは必ず DocumentListener メソッドを介して行われ、また、ある 1 つの時点にはアクティブなスレッドは 1 つしか存在しないと見なします。
同期のサポートが必要な場合は、さらに次の前提条件があります。任意の DocumentListener および UndoListener の実装に対するコードパスがスレッドに対して安全であること、また、デッドロックを避ける場合には、コンポーネントのロックにアクセスしないこと、という条件です。JComponent の repaint
メソッドおよび revalidate
メソッドは安全です。
AbstractDocument はドキュメントの最後に暗黙のブレークをモデル化します。さまざまなことが可能ですが、その 1 つとして最後の文字のあとにキャレットを配置できます。その結果、Content より短い getLength
を返します。独自の Content を生成する場合は、文字を追加して初期化するようにしてください。この例については StringContent と GapContent を参照してください。別の前提条件は、暗黙の最終文字をモデル化する Elements は endOffset == (getLength() + 1) となることです。たとえば、DefaultStyledDocument の場合は getParagraphElement(getLength()).getEndOffset() == getLength() + 1
です。
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。
内部クラスの概要 | |
class |
AbstractDocument.AbstractElement
要素の抽象的な部分を実装します。 |
static interface |
AbstractDocument.AttributeContext
このインタフェースは、プラグイン可能な属性圧縮手法を MutableAttributeSet の実装で使用可能にするために使用できます。 |
class |
AbstractDocument.BranchElement
他の要素を含む複合要素を実装します。 |
static interface |
AbstractDocument.Content
編集可能な文字のシーケンスを示すインタフェースです。 |
class |
AbstractDocument.DefaultDocumentEvent
ドキュメントが変更されるときに、変更を格納します。 |
static class |
AbstractDocument.ElementEdit
ドキュメントのイベントに追加できる ElementChange の実装です。 |
class |
AbstractDocument.LeafElement
内容を直接に表示する要素を実装します。 |
フィールドの概要 | |
protected static String |
BAD_LOCATION
不正な位置を示すエラーメッセージです。 |
static String |
BidiElementName
一方向の実行を示す要素の名前です。 |
static String |
ContentElementName
内容を示す要素の名前です。 |
static String |
ElementNameAttribute
要素の名前の指定に使う属性の名前です。 |
protected EventListenerList |
listenerList
ドキュメントのイベントリスナーです。 |
static String |
ParagraphElementName
段落を示す要素の名前です。 |
static String |
SectionElementName
行、段落などのセクションを示す要素の名前です。 |
インタフェース javax.swing.text.Document から継承したフィールド |
StreamDescriptionProperty, TitleProperty |
コンストラクタの概要 | |
protected |
AbstractDocument(AbstractDocument.Content data)
なんらかの内容記憶機構をラップした、新しい AbstractDocument を構築します。 |
protected |
AbstractDocument(AbstractDocument.Content data,
AbstractDocument.AttributeContext context)
なんらかの内容記憶機構をラップした、新しい AbstractDocument を構築します。 |
メソッドの概要 | |
void |
addDocumentListener(DocumentListener listener)
ドキュメントリスナーを追加し、変更があったときに通知されるようにします。 |
void |
addUndoableEditListener(UndoableEditListener listener)
任意の変更を通知するアンドゥリスナーを追加します。 |
protected Element |
createBranchElement(Element parent,
AttributeSet a)
ドキュメントの枝の要素を作成します。 |
protected Element |
createLeafElement(Element parent,
AttributeSet a,
int p0,
int p1)
ドキュメントの葉の要素を作成します。 |
Position |
createPosition(int offs)
ドキュメントが変更されたときに、変更を追跡する位置を返します。 |
void |
dump(PrintStream out)
診断用のダンプを出力します。 |
protected void |
fireChangedUpdate(DocumentEvent e)
このイベントタイプへの通知を配信対象に登録しているリスナーをすべて通知します。 |
protected void |
fireInsertUpdate(DocumentEvent e)
このイベントタイプへの通知を配信対象に登録しているリスナーをすべて通知します。 |
protected void |
fireRemoveUpdate(DocumentEvent e)
このイベントタイプへの通知を配信対象に登録しているリスナーをすべて通知します。 |
protected void |
fireUndoableEditUpdate(UndoableEditEvent e)
このイベントタイプへの通知を配信対象に登録しているリスナーをすべて通知します。 |
int |
getAsynchronousLoadPriority()
非同期ロードの優先順位を取得します。 |
protected AbstractDocument.AttributeContext |
getAttributeContext()
属性を管理するためのコンテキストを返します。 |
Element |
getBidiRootElement()
ドキュメントの双方向構造のルート要素を返します。 |
protected AbstractDocument.Content |
getContent()
ドキュメントの内容を返します。 |
protected Thread |
getCurrentWriter()
現在の書き込みスレッドがあれば、それを返します。 |
abstract Element |
getDefaultRootElement()
ルート要素を返します。 |
Dictionary |
getDocumentProperties()
プロパティのセットの管理をサポートします。 |
Position |
getEndPosition()
ドキュメントの末尾を表す位置を返します。 |
int |
getLength()
データの長さを返します。 |
EventListener[] |
getListeners(Class listenerType)
このモデルに追加された、指定されたタイプのリスナーすべての配列を返します。 |
abstract Element |
getParagraphElement(int pos)
指定された位置を含む段落要素を返します。 |
Object |
getProperty(Object key)
プロパティの値を調べるのに便利なメソッドです。 |
Element[] |
getRootElements()
定義されているルート要素をすべて返します。 |
Position |
getStartPosition()
ドキュメントの先頭を表す位置を返します。 |
String |
getText(int offset,
int length)
ドキュメントからテキストのシーケンスを取得します。 |
void |
getText(int offset,
int length,
Segment txt)
ドキュメントからテキストを取得しますが、コピーは作成しません。 |
void |
insertString(int offs,
String str,
AttributeSet a)
ドキュメントに内容を挿入します。 |
protected void |
insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
AttributeSet attr)
テキスト挿入の結果として、ドキュメントの構造を更新します。 |
protected void |
postRemoveUpdate(AbstractDocument.DefaultDocumentEvent chng)
テキスト削除の結果として、任意のドキュメントの構造を更新します。 |
void |
putProperty(Object key,
Object value)
プロパティの値を格納するのに便利なメソッドです。 |
void |
readLock()
ロックを取得して、ドキュメントからなんらかの状態の読み込みを開始できるようにします。 |
void |
readUnlock()
読み込みのロックを解除します。 |
void |
remove(int offs,
int len)
ドキュメントから内容を削除します。 |
void |
removeDocumentListener(DocumentListener listener)
リスナーを削除します。 |
void |
removeUndoableEditListener(UndoableEditListener listener)
アンドゥリスナーを削除します。 |
protected void |
removeUpdate(AbstractDocument.DefaultDocumentEvent chng)
テキスト削除の結果として、任意のドキュメントの構造を更新します。 |
void |
render(Runnable r)
モデルが非同期的な更新をサポートしている場合、並行性に直面してモデルを安全に描画できるようにします。 |
void |
setAsynchronousLoadPriority(int p)
非同期ロードの優先順位を設定します。 |
void |
setDocumentProperties(Dictionary x)
このドキュメントのドキュメントプロパティの辞書を置き換えます。 |
protected void |
writeLock()
ロックを取得して、ロックが保護しているドキュメントの変更を開始できるようにします。 |
protected void |
writeUnlock()
書き込み操作が終了したときに、保持されていた書き込みロックを解放します。 |
クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
protected EventListenerList listenerList
protected static final String BAD_LOCATION
public static final String ParagraphElementName
public static final String ContentElementName
public static final String SectionElementName
public static final String BidiElementName
public static final String ElementNameAttribute
コンストラクタの詳細 |
protected AbstractDocument(AbstractDocument.Content data)
data
- コンテンツprotected AbstractDocument(AbstractDocument.Content data, AbstractDocument.AttributeContext context)
data
- コンテンツcontext
- 属性のコンテキストメソッドの詳細 |
public Dictionary getDocumentProperties()
setDocumentProperties(java.util.Dictionary)
public void setDocumentProperties(Dictionary x)
x
- 新規辞書getDocumentProperties()
protected void fireInsertUpdate(DocumentEvent e)
e
- イベントEventListenerList
protected void fireChangedUpdate(DocumentEvent e)
e
- イベントEventListenerList
protected void fireRemoveUpdate(DocumentEvent e)
e
- イベントEventListenerList
protected void fireUndoableEditUpdate(UndoableEditEvent e)
e
- イベントEventListenerList
public EventListener[] getListeners(Class listenerType)
public int getAsynchronousLoadPriority()
public void setAsynchronousLoadPriority(int p)
public void render(Runnable r)
この実装は、実行している間、読み込みロックを取得するためのものです。複数を同時に実行している場合、アクティブに描画中のオブジェクトがある間は、すべての書き込みがブロックされます。オブジェクトが例外をスローした場合、そのロックは安全に解放されます。決して終了しないオブジェクトに対する保護はなく、事実上、ドキュメントは自身が存在する間ずっとロックされます。
指定されたオブジェクトがどのような変更を試みても、デッドロックが発生します。この状況を検知できるようにするために個々の描画スレッドを追跡することはできません。また、サブクラスは、描画スレッドの追跡、およびエラーのスローのオーバーヘッドを発生させる可能性があります。
このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。
Document
内の render
r
- 実行するレンダリングpublic int getLength()
Document
内の getLength
Document.getLength()
public void addDocumentListener(DocumentListener listener)
Document
内の addDocumentListener
listener
- リスナーDocument.addDocumentListener(javax.swing.event.DocumentListener)
public void removeDocumentListener(DocumentListener listener)
Document
内の removeDocumentListener
listener
- リスナーDocument.removeDocumentListener(javax.swing.event.DocumentListener)
public void addUndoableEditListener(UndoableEditListener listener)
Document
内の addUndoableEditListener
listener
- リスナーDocument.addUndoableEditListener(javax.swing.event.UndoableEditListener)
public void removeUndoableEditListener(UndoableEditListener listener)
Document
内の removeUndoableEditListener
listener
- リスナーDocument.removeDocumentListener(javax.swing.event.DocumentListener)
public final Object getProperty(Object key)
getDocumentProperties().get(key);
Document
内の getProperty
key
- null 以外のプロパティキーgetDocumentProperties()
public final void putProperty(Object key, Object value)
getDocumentProperties().put(key, value);値が null の場合、このメソッドはプロパティを削除します。
Document
内の putProperty
key
- null 以外のキーvalue
- 値getDocumentProperties()
public void remove(int offs, int len) throws BadLocationException
このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。
Document
内の remove
offs
- オフセット開始 >= 0len
- 削除対象の文字数 >= 0BadLocationException
- 指定された削除の位置が、ドキュメント内の有効な位置ではない場合Document.remove(int, int)
public void insertString(int offs, String str, AttributeSet a) throws BadLocationException
このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。
Document
内の insertString
offs
- オフセット開始 >= 0str
- 挿入する文字列。null や空の文字列の場合は何もしないa
- 挿入されたコンテンツの属性BadLocationException
- 指定された挿入の位置が、ドキュメント内の有効な位置ではない場合Document.insertString(int, java.lang.String, javax.swing.text.AttributeSet)
public String getText(int offset, int length) throws BadLocationException
Document
内の getText
offset
- オフセット開始 >= 0length
- 検索対象の文字数 >= 0BadLocationException
- 指定された範囲に、ドキュメント内では無効な位置が含まれる場合Document.getText(int, int)
public void getText(int offset, int length, Segment txt) throws BadLocationException
Segment
に返された文字配列は、変更しないでください。ドキュメントの文字に対するこうしたアクセス方法は、描画をより効率的にするために提供されています。呼び出し側は、返された文字配列の寿命について想定しないでください。文字配列を描画以外に使う必要がある場合は、その文字配列をコピーします。Document
内の getText
offset
- オフセット開始 >= 0length
- 検索対象の文字数 >= 0txt
- テキストを取得する Segment オブジェクトBadLocationException
- 指定された範囲に、ドキュメント内では無効な位置が含まれる場合public Position createPosition(int offs) throws BadLocationException
このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。
Document
内の createPosition
offs
- モデル内の位置 >= 0BadLocationException
- 指定された位置が、関連したドキュメント内の有効な位置を表さない場合Document.createPosition(int)
public final Position getStartPosition()
Document
内の getStartPosition
public final Position getEndPosition()
Document
内の getEndPosition
public Element[] getRootElements()
Document
内の getRootElements
public abstract Element getDefaultRootElement()
Document
内の getDefaultRootElement
Document.getDefaultRootElement()
public Element getBidiRootElement()
public abstract Element getParagraphElement(int pos)
pos
- オフセット開始 >= 0protected final AbstractDocument.AttributeContext getAttributeContext()
protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)
chng
- 変更の説明attr
- 変更の属性protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)
chng
- 変更の説明protected void postRemoveUpdate(AbstractDocument.DefaultDocumentEvent chng)
chng
- 変更の説明public void dump(PrintStream out)
out
- 出力ストリームprotected final AbstractDocument.Content getContent()
protected Element createLeafElement(Element parent, AttributeSet a, int p0, int p1)
parent
- 親要素a
- 要素の属性p0
- 範囲の始点 >= 0p1
- 範囲の終点 >= p0protected Element createBranchElement(Element parent, AttributeSet a)
parent
- 親要素a
- 属性protected final Thread getCurrentWriter()
protected final void writeLock()
IllegalStateException
- 不正なロックを試みた場合にスローされる。ドキュメントが適切に実装されていれば、ドキュメントリスナーがドキュメントの変更を試みた場合に限りこの例外が発生する。こうした状況は、Bean イベントモデルに違反している。このイベントモデルでは配信の順序に保証はなく、変更が許可される前に、すべてのリスナーに通知される必要がある。protected final void writeUnlock()
public final void readLock()
readUnlock
を呼び出してください。readUnlock()
public final void readUnlock()
readLock();
try {
// do something
} finally {
readUnlock();
}
readLock()
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 内部クラス | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Java、Java 2D、JDBC は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.