javax.swing.text
クラス AbstractWriter

java.lang.Object
  |
  +--javax.swing.text.AbstractWriter

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

HTMLWriter, MinimalHTMLWriter

public abstract class AbstractWriter

extends Object

AbstractWriter は、属性を含む要素ツリーを実際に書き出す抽象クラスです。1 行あたりに書き出す文字数のデフォルトは 80 です。ただし、この値はサブクラスで設定することができます。

フィールドの概要

protected static char

NEWLINE

コンストラクタの概要

protected	AbstractWriter(Writer w, Document doc) 新しい AbstractWriter を作成します。
protected	AbstractWriter(Writer w, Document doc, int pos, int len) 新しい AbstractWriter を作成します。
protected	AbstractWriter(Writer w, Element root) 新しい AbstractWriter を作成します。
protected	AbstractWriter(Writer w, Element root, int pos, int len) 新しい AbstractWriter を作成します。

メソッドの概要

protected void	decrIndent() インデントレベルをデクリメントします。
protected Document	getDocument() ドキュメントを取得します。
protected ElementIterator	getElementIterator() ElementIterator を取得します。
protected String	getText(Element elem) 要素に関連付けられているテキストを返します。
protected void	incrIndent() インデントレベルをインクリメントします。
protected void	indent() インデントを行います。
protected boolean	inRange(Element next) このメソッドは、現在の要素が指定された範囲内にあるかどうかを判定します。
protected void	setIndentSpace(int space) インデントにマッピングするスペースの数をサブクラスから指定できるようにします。
protected void	setLineLength(int l) 1 行あたりに書き込むことのできる文字数をサブクラスから設定できるようにします。
protected void	text(Element elem) テキストを書き出します。
protected abstract void	write() この abstract メソッドは、サブクラスによって実装される必要があります。
protected void	write(char ch) 文字を書き出します。
protected void	write(String str) 文字列を書き出します。
protected void	writeAttributes(AttributeSet attr) 属性セットを "<名前>=<値>" のペアとして書き出します。

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

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

フィールドの詳細

NEWLINE

protected static final char NEWLINE

コンストラクタの詳細

AbstractWriter

protected AbstractWriter(Writer w,
                         Document doc)

新しい AbstractWriter を作成します。デフォルトのドキュメントルートを使って ElementIterator を初期化します。

パラメータ:

w - ライター

doc - ドキュメント

AbstractWriter

protected AbstractWriter(Writer w,
                         Document doc,
                         int pos,
                         int len)

新しい AbstractWriter を作成します。渡されたドキュメントを使って ElementIterator を初期化します。

パラメータ:

w - ライター

doc - ドキュメント

pos - 取得対象コンテンツのドキュメント内での位置

len - 書き出す量

AbstractWriter

protected AbstractWriter(Writer w,
                         Element root)

新しい AbstractWriter を作成します。渡された要素を使って ElementIterator を初期化します。

パラメータ:

w - ライター

root - 要素

AbstractWriter

protected AbstractWriter(Writer w,
                         Element root,
                         int pos,
                         int len)

新しい AbstractWriter を作成します。渡された要素を使って ElementIterator を初期化します。

パラメータ:

w - ライター

root - 要素

pos - 取得対象コンテンツのドキュメント内での位置

len - 書き出す量

メソッドの詳細

getElementIterator

protected ElementIterator getElementIterator()

ElementIterator を取得します。

戻り値:

ElementIterator

getDocument

protected Document getDocument()

ドキュメントを取得します。

戻り値:

Document

inRange

protected boolean inRange(Element next)

このメソッドは、現在の要素が指定された範囲内にあるかどうかを判定します。範囲が指定されなかった場合は、ドキュメント全体が範囲として初期化されます。inRange() は、指定された範囲が要素の範囲と交差している場合に true を返します。

パラメータ:

next - 要素

戻り値:

要素が範囲内かどうかを示す boolean 型の値

write

protected abstract void write()
                       throws IOException,
                              BadLocationException

この abstract メソッドは、サブクラスによって実装される必要があります。この abstract メソッドの役割は、要素を反復し、write() メソッドを使って必要な形式の出力を生成することです。

getText

protected String getText(Element elem)
                  throws BadLocationException

要素に関連付けられているテキストを返します。このメソッドは、渡された要素が葉の要素であると仮定します。例外が発生すると BadLocationException をスローします。

パラメータ:

elem - 要素

戻り値:

String としてのテキスト

例外:

BadLocationException - pos がドキュメント内の無効な位置を表している場合

text

protected void text(Element elem)
             throws BadLocationException,
                    IOException

テキストを書き出します。コンストラクタが呼び出されたときに範囲が指定されている場合は、該当範囲内のテキストだけが書き出されます。

パラメータ:

elem - 要素

例外:

IOException - 入出力エラーが発生した場合

BadLocationException - pos がドキュメント内の無効な位置を表している場合

setLineLength

protected void setLineLength(int l)

1 行あたりに書き込むことのできる文字数をサブクラスから設定できるようにします。デフォルトは 100 です。

パラメータ:

l - 行の長さの最大値

setIndentSpace

protected void setIndentSpace(int space)

インデントにマッピングするスペースの数をサブクラスから指定できるようにします。インデントを行うと、インデントレベルとマッピングの積が計算されます。デフォルトは 2 です。

パラメータ:

space - インデントにマッピングするスペースの数を表す int 値

incrIndent

protected void incrIndent()

インデントレベルをインクリメントします。

decrIndent

protected void decrIndent()

インデントレベルをデクリメントします。

indent

protected void indent()
               throws IOException

インデントを行います。書き出されるスペースの数は、インデントレベルと、マッピングされたスペースの数の積になります。

例外:

IOException - 入出力エラーが発生した場合

write

protected void write(char ch)
              throws IOException

文字を書き出します。改行文字の場合には、現在の長さを 0 にリセットします。現在の長さが行の長さの最大値に等しい場合は、改行文字を出力して現在の長さを 0 にリセットします。

パラメータ:

ch - 文字

例外:

IOException - 入出力エラーが発生した場合

write

protected void write(String str)
              throws IOException

文字列を書き出します。文字列を現在の行に書き出すと行長の最大値を超えてしまう場合は、次の行への書き出しを試みます。しかし、文字列の長さそのものが行長の最大値を超える場合は、位置 0 から行長の最大値の位置までの部分文字列についてこのメソッドを再帰的に呼び出します。そして、(行長の最大値 + 1) の位置から文字列の終端まで同様の操作を繰り返します。書き出し時には、必要に応じて改行を挿入します。

パラメータ:

str - 文字列

例外:

IOException - 入出力エラーが発生した場合

writeAttributes

protected void writeAttributes(AttributeSet attr)
                        throws IOException

属性セットを "<名前>=<値>" のペアとして書き出します。入出力エラーが発生すると IOException をスローします。

パラメータ:

attr - 属性セット

例外:

IOException - 入出力エラーが発生した場合