DefaultStyledDocument (Java Platform SE 7)

java.lang.Object
- javax.swing.text.AbstractDocument
- - javax.swing.text.DefaultStyledDocument

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

Serializable, Document, StyledDocument

直系の既知のサブクラス:

HTMLDocument
```
public class DefaultStyledDocument
extends AbstractDocument
implements StyledDocument
```
RTF (Rich Text Format) に類似した方式を使って、字体や段落書式をマークアップできるドキュメントです。このドキュメントの要素構造は、スタイルランのスタイルの組み合わせを表します。こうしたスタイルランは、段落要素の構造 (ほかの構造に格納されている場合もあり) に対応付けられます。論理書式が段落境界に指定されているので、スタイルランは段落境界で分割されます。
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースとの互換性がなくなる予定です。現在の直列化のサポートは、短期間の格納や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。1.4 以降、すべての JavaBeans^TM 用の長期間の格納サポートが java.beans パッケージに追加されています。XMLEncoder を参照してください。

関連項目:
Document, AbstractDocument

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`DefaultStyledDocument.AttributeUndoableEdit` UndoableEdit は、Element の AttributeSet に加えられた変更を記憶するために使います。
`class`	`DefaultStyledDocument.ElementBuffer` 要素の階層に対する変更を管理するクラスです。
`static class`	`DefaultStyledDocument.ElementSpec` 要素を構築する実装です。
`protected class`	`DefaultStyledDocument.SectionElement` ドキュメントのデフォルトルート要素です。

クラス javax.swing.text.AbstractDocument から継承されたネストされたクラス/インタフェース
AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`protected DefaultStyledDocument.ElementBuffer`	`buffer`
`static int`	`BUFFER_SIZE_DEFAULT` 初期コンテンツバッファーのデフォルトサイズです。

クラス javax.swing.text.AbstractDocument から継承されたフィールド
BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

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

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`DefaultStyledDocument()` デフォルトの書式付きドキュメントを構築します。
`DefaultStyledDocument(AbstractDocument.Content c, StyleContext styles)` 書式付きドキュメントを構築します。
`DefaultStyledDocument(StyleContext styles)` デフォルトのコンテンツストレージの実装と書式の共有セットを使って、書式付きドキュメントを構築します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`void`	`addDocumentListener(DocumentListener listener)` ドキュメントリスナーを追加し、変更があったときに通知されるようにします。
`Style`	`addStyle(String nm, Style parent)` 論理書式階層に新しい書式を追加します。
`protected void`	`create(DefaultStyledDocument.ElementSpec[] data)` ドキュメントを初期化して、指定された要素構造を反映します。
`protected AbstractDocument.AbstractElement`	`createDefaultRoot()` デフォルトのドキュメント構造を表すために使うルート要素を作成します。
`Color`	`getBackground(AttributeSet attr)` 属性セットからバックグラウンドカラーを取得します。
`Element`	`getCharacterElement(int pos)` 位置に基づいて文字要素を取得します。
`Element`	`getDefaultRootElement()` デフォルトのルート要素を取得します。
`Font`	`getFont(AttributeSet attr)` 属性セットからフォントを取得します。
`Color`	`getForeground(AttributeSet attr)` 属性セットからフォアグラウンドカラーを取得します。
`Style`	`getLogicalStyle(int p)` 指定された位置によって表された段落に割り当てられた論理書式を取得します。
`Element`	`getParagraphElement(int pos)` オフセット `pos` の段落の要素を取得します。
`Style`	`getStyle(String nm)` 以前に追加された名前付き書式を取得します。
`Enumeration<?>`	`getStyleNames()` 書式名のリストを取得します。
`protected void`	`insert(int offset, DefaultStyledDocument.ElementSpec[] data)` 新しい要素を一括して挿入します。
`protected void`	`insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)` ドキュメント構造をテキスト挿入の結果で更新します。
`void`	`removeDocumentListener(DocumentListener listener)` ドキュメントリスナーを削除します。
`void`	`removeElement(Element elem)` このドキュメントから要素を削除します。
`void`	`removeStyle(String nm)` 以前にドキュメントに追加された名前付き書式を削除します。
`protected void`	`removeUpdate(AbstractDocument.DefaultDocumentEvent chng)` テキスト削除の結果としてドキュメント構造を更新します。
`void`	`setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace)` ドキュメントの一部に属性を設定します。
`void`	`setLogicalStyle(int pos, Style s)` 指定された位置の段落に使用する論理書式を設定します。
`void`	`setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace)` 段落に属性を設定します。
`protected void`	`styleChanged(Style style)` このドキュメントの書式が変更されたときに呼び出されます。

クラス 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

- フィールドの詳細
  - BUFFER_SIZE_DEFAULT
```
public static final int BUFFER_SIZE_DEFAULT
```
    初期コンテンツバッファーのデフォルトサイズです。
    
    関連項目:
    定数フィールド値
  - buffer
```
protected DefaultStyledDocument.ElementBuffer buffer
```
- コンストラクタの詳細
  - DefaultStyledDocument
```
public DefaultStyledDocument(AbstractDocument.Content c,
                     StyleContext styles)
```
    書式付きドキュメントを構築します。
    
    パラメータ:
    c - コンテンツのコンテナ
    styles - ドキュメント間で共有できるリソースと書式定義
  - DefaultStyledDocument
```
public DefaultStyledDocument(StyleContext styles)
```
    デフォルトのコンテンツストレージの実装と書式の共有セットを使って、書式付きドキュメントを構築します。
    
    パラメータ:
    styles - スタイル
  - DefaultStyledDocument
```
public DefaultStyledDocument()
```
    デフォルトの書式付きドキュメントを構築します。これは入力コンテンツを BUFFER_SIZE_DEFAULT のサイズによってバッファー処理し、ドキュメントの寿命によってスコープされたスタイルコンテキストを持ち、ほかのドキュメントとは共有されません。
- メソッドの詳細
  - getDefaultRootElement
```
public Element getDefaultRootElement()
```
    デフォルトのルート要素を取得します。
    
    定義:
    
    getDefaultRootElement、インタフェース: Document
    
    定義:
    
    getDefaultRootElement、クラス: AbstractDocument
    
    戻り値:
    ルート
    関連項目:
    Document.getDefaultRootElement()
  - create
```
protected void create(DefaultStyledDocument.ElementSpec[] data)
```
    ドキュメントを初期化して、指定された要素構造 (getDefaultRootElement メソッドによって報告される構造) を反映します。ドキュメントがなんらかのデータを保持している場合、それが最初に削除されます。
  - insert
```
protected void insert(int offset,
          DefaultStyledDocument.ElementSpec[] data)
               throws BadLocationException
```
    新しい要素を一括して挿入します。これは、ロック解除状態のドキュメントを構文解析して、要素構造の変更を準備するのに役立ちます。このメソッドは、要素構造を更新する方法を記述するトークンの配列を取得するので、書き込みロックに入る時間を非同期的な更新状況で大幅に減らすことができます。
    このメソッドはスレッドセーフですが、ほとんどの Swing メソッドは違います。詳細は、「How to Use Threads」を参照してください。
    
    パラメータ:
    offset - 開始オフセット >= 0
    data - 要素データ
    
    例外:
    
    BadLocationException - 開始オフセットが無効な場合
  - removeElement
```
public void removeElement(Element elem)
```
    このドキュメントから要素を削除します。
    要素はその要素によって識別される範囲内のテキストと一緒に、その親要素から削除されます。要素がドキュメントと関連付けられていない場合、IllegalArgumentException がスローされます。
    
    ドキュメント内に空の枝の要素があることは許可されないため、要素が唯一の子の場合、その親要素も再帰的に削除されます。したがって、ある要素のすべての子を置換する場合、古い子を削除する前に新しい子を追加する必要があります。
    要素を削除すると、要素構造の変化に対する DocumentEvent と、ドキュメント内容の変更に対する UndoableEditEvent の 2 つのイベントがトリガーされます。
    
    要素にコンテンツの終わりのマークが含まれている場合 (ドキュメントの最後の "\n" 文字)、この文字は削除されず、その前の葉要素が拡張されてこの文字を含めます。最後の葉がすでに "\n", で終わっている場合、その文字はコンテンツの削除に含められます。
    
    要素が null の場合、NullPointerException がスローされます。削除後に要素構造が無効になる場合 (たとえば要素がドキュメントのルート要素である場合)、IllegalArgumentException がスローされます。現在の要素構造が無効である場合、IllegalStateException がスローされます。
    
    パラメータ:
    elem - 削除する要素
    
    例外:
    
    NullPointerException - 要素が null の場合
    
    IllegalArgumentException - 要素を削除できなかった場合
    
    IllegalStateException - 要素の構造が無効な場合
    導入されたバージョン:
    
    1.7
  - addStyle
```
public Style addStyle(String nm,
             Style parent)
```
    論理書式階層に新しい書式を追加します。書式の属性は下から上に向かって解釈処理されるので、子で指定された属性は親で指定された属性をオーバーライドします。
    
    定義:
    
    addStyle、インタフェース: StyledDocument
    
    パラメータ:
    nm - 書式の名前。この名前は、名前付き書式のコレクションの中で一意でなければならない。名前は、書式に名前が付いていない場合は null も可能だが、呼び出し側は名前のない書式が名前で取得できない場合に返される参照を管理しなければならない。名前のない書式は、スタイルランで見られるような文字属性のオーバーライドなどで便利な場合がある。
    parent - 親書式。指定されていない属性がほかの書式で解釈処理される必要がない場合は null も可。
    
    戻り値:
    書式
  - removeStyle
```
public void removeStyle(String nm)
```
    以前にドキュメントに追加された名前付き書式を削除します。
    
    定義:
    
    removeStyle、インタフェース: StyledDocument
    
    パラメータ:
    nm - 削除される書式の名前
  - getStyle
```
public Style getStyle(String nm)
```
    以前に追加された名前付き書式を取得します。
    
    定義:
    
    getStyle、インタフェース: StyledDocument
    
    パラメータ:
    nm - 書式の名前
    
    戻り値:
    書式
  - getStyleNames
```
public Enumeration<?> getStyleNames()
```
    書式名のリストを取得します。
    
    戻り値:
    すべての書式名
  - setLogicalStyle
```
public void setLogicalStyle(int pos,
                   Style s)
```
    指定された位置の段落に使用する論理書式を設定します。文字および段落の属性に対して明示的に属性が設定されていない場合、属性はその段落に割り当てられている論理書式を介して解釈処理されます。論理書式は、ドキュメント内の要素階層にまったく依存しない階層を介して解釈処理されます。
    このメソッドはスレッドセーフですが、ほとんどの Swing メソッドは違います。詳細は、「How to Use Threads」を参照してください。
    
    定義:
    
    setLogicalStyle、インタフェース: StyledDocument
    
    パラメータ:
    pos - ドキュメントの先頭からのオフセット >= 0
    s - 段落に割り当てられた論理書式。ない場合は null
  - getLogicalStyle
```
public Style getLogicalStyle(int p)
```
    指定された位置によって表された段落に割り当てられた論理書式を取得します。
    
    定義:
    
    getLogicalStyle、インタフェース: StyledDocument
    
    パラメータ:
    p - 段落に変換して、割り当てる論理書式を指定する位置 >= 0。これは、ドキュメントの先頭からのオフセット。
    
    戻り値:
    書式。ない場合は null
  - setCharacterAttributes
```
public void setCharacterAttributes(int offset,
                          int length,
                          AttributeSet s,
                          boolean replace)
```
    ドキュメントの一部に属性を設定します。この処理は変更の実行中に書き込みロックを保持し、変更が適切に完了すると DocumentEvent がリスナーに送られます。
    このメソッドはスレッドセーフですが、ほとんどの Swing メソッドは違います。詳細は、「How to Use Threads」を参照してください。
    
    定義:
    
    setCharacterAttributes、インタフェース: StyledDocument
    
    パラメータ:
    offset - ドキュメントのオフセット >= 0
    length - 長さ >= 0
    s - 属性
    replace - 新しい属性の設定前に従来の属性を置換する必要がある場合は true
  - setParagraphAttributes
```
public void setParagraphAttributes(int offset,
                          int length,
                          AttributeSet s,
                          boolean replace)
```
    段落に属性を設定します。
    このメソッドはスレッドセーフですが、ほとんどの Swing メソッドは違います。詳細は、「How to Use Threads」を参照してください。
    
    定義:
    
    setParagraphAttributes、インタフェース: StyledDocument
    
    パラメータ:
    offset - 段落に対するオフセット >= 0
    length - 影響を受ける文字数 >= 0
    s - 属性
    replace - 既存の属性を置換するか、マージするか
  - getParagraphElement
```
public Element getParagraphElement(int pos)
```
    オフセット pos の段落の要素を取得します。1 つの段落は、少なくとも 1 つの、通常は葉である子の Element から構成されています。
    
    定義:
    
    getParagraphElement、インタフェース: StyledDocument
    
    定義:
    
    getParagraphElement、クラス: AbstractDocument
    
    パラメータ:
    pos - 開始オフセット >= 0
    
    戻り値:
    要素
  - getCharacterElement
```
public Element getCharacterElement(int pos)
```
    位置に基づいて文字要素を取得します。
    
    定義:
    
    getCharacterElement、インタフェース: StyledDocument
    
    パラメータ:
    pos - ドキュメント内の位置 >= 0
    
    戻り値:
    要素
  - insertUpdate
```
protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
                AttributeSet attr)
```
    ドキュメント構造をテキスト挿入の結果で更新します。これは、書き込みロック内で発生します。この実装は、挿入されたコンテンツを単に改行ごとに構文解析し、要素バッファーに対する一連の指示を構築します。
    
    オーバーライド:
    
    insertUpdate、クラス: AbstractDocument
    
    パラメータ:
    chng - ドキュメント変更の説明
    attr - 属性
  - removeUpdate
```
protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)
```
    テキスト削除の結果としてドキュメント構造を更新します。
    
    オーバーライド:
    
    removeUpdate、クラス: AbstractDocument
    
    パラメータ:
    chng - ドキュメント変更の説明
  - createDefaultRoot
```
protected AbstractDocument.AbstractElement createDefaultRoot()
```
    デフォルトのドキュメント構造を表すために使うルート要素を作成します。
    
    戻り値:
    要素ベース
  - getForeground
```
public Color getForeground(AttributeSet attr)
```
    属性セットからフォアグラウンドカラーを取得します。
    
    定義:
    
    getForeground、インタフェース: StyledDocument
    
    パラメータ:
    attr - 属性セット
    
    戻り値:
    色
  - getBackground
```
public Color getBackground(AttributeSet attr)
```
    属性セットからバックグラウンドカラーを取得します。
    
    定義:
    
    getBackground、インタフェース: StyledDocument
    
    パラメータ:
    attr - 属性セット
    
    戻り値:
    色
  - getFont
```
public Font getFont(AttributeSet attr)
```
    属性セットからフォントを取得します。
    
    定義:
    
    getFont、インタフェース: StyledDocument
    
    パラメータ:
    attr - 属性セット
    
    戻り値:
    フォント
  - styleChanged
```
protected void styleChanged(Style style)
```
    このドキュメントの書式が変更されたときに呼び出されます。サブクラスでは、何がダメージを受けたかわかるようにする必要があることがあります。
    
    パラメータ:
    style - 変更された Style
  - addDocumentListener
```
public void addDocumentListener(DocumentListener listener)
```
    ドキュメントリスナーを追加し、変更があったときに通知されるようにします。
    
    定義:
    
    addDocumentListener、インタフェース: Document
    
    オーバーライド:
    
    addDocumentListener、クラス: AbstractDocument
    
    パラメータ:
    listener - リスナー
    関連項目:
    Document.addDocumentListener(javax.swing.event.DocumentListener)
  - removeDocumentListener
```
public void removeDocumentListener(DocumentListener listener)
```
    ドキュメントリスナーを削除します。
    
    定義:
    
    removeDocumentListener、インタフェース: Document
    
    オーバーライド:
    
    removeDocumentListener、クラス: AbstractDocument
    
    パラメータ:
    listener - リスナー
    関連項目:
    Document.removeDocumentListener(javax.swing.event.DocumentListener)

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス DefaultStyledDocument

ネストされたクラスのサマリー

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

フィールドのサマリー

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

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

コンストラクタのサマリー

メソッドのサマリー

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

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

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

フィールドの詳細

BUFFER_SIZE_DEFAULT

buffer

コンストラクタの詳細

DefaultStyledDocument

DefaultStyledDocument

DefaultStyledDocument

メソッドの詳細

getDefaultRootElement

create

insert

removeElement

addStyle

removeStyle

getStyle

getStyleNames

setLogicalStyle

getLogicalStyle

setCharacterAttributes

setParagraphAttributes

getParagraphElement

getCharacterElement

insertUpdate

removeUpdate

createDefaultRoot

getForeground

getBackground

getFont

styleChanged

addDocumentListener

removeDocumentListener