java.awt.font

クラス TextMeasurer

java.lang.Object

java.awt.font.TextMeasurer

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

Cloneable

public final class TextMeasurer
extends Object
implements Cloneable

TextMeasurer クラスは、有効幅の測定、文字範囲の有効幅の指定、文字範囲の TextLayout の作成など、改行に必要な基本操作を提供します。パラグラフが増えた場合の編集メソッドも提供します。

TextMeasurer オブジェクトは、1 段落のテキストを表す AttributedCharacterIterator で構築されます。AttributedCharacterIterator の getBeginIndex メソッドが返す値は、最初の文字の絶対インデックスを定義します。AttributedCharacterIterator の getEndIndex メソッドが返す値は、最後の文字の次のインデックスを定義します。これらの値によって、TextMeasurer を呼び出すときに使用するインデックスの範囲が定義されます。たとえば、テキストの範囲の有効幅、つまりテキストの範囲の改行を取得するための呼び出しでは、開始インデックス値と終了インデックス値の間のインデックスを使用する必要があります。insertChar および deleteChar を呼び出すと、TextMeasurer がリセットされ、これらの呼び出しで渡された AttributedCharacterIterator の開始インデックスと終了インデックスが使用されます。

ほとんどのクライアントは、標準改行ポリシー (各行に配置できるだけの文字を配置) を実装する便利な LineBreakMeasurer を使用します。

導入されたバージョン:

1.3

関連項目:

LineBreakMeasurer

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

コンストラクタ

コンストラクタと説明
TextMeasurer(AttributedCharacterIterator text, FontRenderContext frc) ソーステキストから TextMeasurer を構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
protected Object	clone() このオブジェクトのコピーを作成して、返します。
void	deleteChar(AttributedCharacterIterator newParagraph, int deletePos) この TextMeasurer が現在表すパラグラフで 1 文字を削除してから TextMeasurer を更新します。
float	getAdvanceBetween(int start, int limit) start で始まり、limit までの文字を含む行のグラフィック幅を返します。
TextLayout	getLayout(int start, int limit) 指定された文字範囲の TextLayout を返します。
int	getLineBreakIndex(int start, float maxAdvance) start で始まり、グラフィック幅が maxAdvance の行に配置できない最初の文字のインデックスを返します。
void	insertChar(AttributedCharacterIterator newParagraph, int insertPos) この TextMeasurer が現在表すパラグラフへ 1 文字を挿入してから TextMeasurer を更新します。

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

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

コンストラクタの詳細

TextMeasurer

public TextMeasurer(AttributedCharacterIterator text,
            FontRenderContext frc)

ソーステキストから TextMeasurer を構築します。ソーステキストは 1 段落全体になります。

パラメータ:

text - ソース段落。null は不可。

frc - テキストを正確に測定するために必要なグラフィックスデバイスに関する情報。null は不可。

メソッドの詳細

clone

protected Object clone()

次のクラスからコピーされた説明: Object

このオブジェクトのコピーを作成して、返します。「コピー」の正確な意味合いは、オブジェクトのクラスによって異なります。一般的な意図は、任意のオブジェクト x について、次の式

 x.clone() != x

が true であり、次の式

 x.clone().getClass() == x.getClass()

が true になることですが、これらは絶対的な要件ではありません。また次の式

 x.clone().equals(x)

が true になりますが、これは絶対的な要件ではありません。

慣例上、返されたオブジェクトは、super.clone を呼び出すことによって取得するようにしてください。クラスとそのすべてのスーパークラス (Object を除く) がこの規則に従っている場合は、x.clone().getClass() == x.getClass() が成立します。

通常、このメソッドにより返されるオブジェクトは、このオブジェクト (複製されている) から独立している必要があります。この独立性を実現するには、super.clone によって返されたオブジェクトを返す前に、その 1 つ以上のフィールドを変更することが必要になる場合があります。これは、通常、複製するオブジェクトの内部「深層構造」を構成する可変オブジェクトのコピー、およびこれらのオブジェクトへの参照をコピーへの参照に置き換えることを意味します。クラスにプリミティブフィールドまたは不変オブジェクトへの参照しか含まれていない場合は、通常、super.clone によって返されたオブジェクト内のフィールドを変更する必要がありません。

クラス Object のメソッド clone は、特定のクローニング操作を実行します。まず、このオブジェクトのクラスがインタフェース Cloneable を実装していない場合は、CloneNotSupportedException がスローされます。すべての配列がインタフェース Cloneable を実装していると見なされること、および配列型 T[] の clone メソッドの戻り値の型は T[] (ここで、T は任意の参照またはプリミティブ型) です。実装していない場合、このメソッドはこのオブジェクトのクラスの新しいインスタンスを生成し、そのフィールドをすべて、このオブジェクトの対応する各フィールドの内容で初期化します。これは代入と同様で、フィールドの内容自身が複製されるのではありません。つまりこのメソッドは、オブジェクトの「シャローコピー」を生成しますが、「ディープコピー」は生成しません。

クラス Object 自体はインタフェース Cloneable を実装していないため、クラスが Object であるオブジェクトに対して clone メソッドを呼び出すと、実行時に例外がスローされます。

オーバーライド:

clone、クラス: Object

戻り値:

このインスタンスの複製。

関連項目:

Cloneable

getLineBreakIndex

public int getLineBreakIndex(int start,
                    float maxAdvance)

start で始まり、グラフィック幅が maxAdvance の行に配置できない最初の文字のインデックスを返します。

パラメータ:

start - 測定を開始する位置の文字インデックス。start は絶対インデックスで、段落の開始位置を基準にしたものではない

maxAdvance - 行を配置するグラフィック幅

戻り値:

start で始まり、グラフィック幅が maxAdvance 以内の行に配置できる最後の文字の後のインデックス

例外:

IllegalArgumentException - start が段落の開始位置より前の場合。

getAdvanceBetween

public float getAdvanceBetween(int start,
                      int limit)

start で始まり、limit までの文字を含む行のグラフィック幅を返します。start と limit は絶対インデックスで、段落の開始位置を基準にしたものではありません。

パラメータ:

start - 測定を開始する位置の文字インデックス

limit - 測定を終了する位置の文字インデックス

戻り値:

start で始まり、limit までの文字を含む行のグラフィック幅

例外:

IndexOutOfBoundsException - limit が start より前の場合

IllegalArgumentException - start または limit が段落の開始位置と終了位置の間にない場合。

getLayout

public TextLayout getLayout(int start,
                   int limit)

指定された文字範囲の TextLayout を返します。

パラメータ:

start - 最初の文字のインデックス

limit - 最後の文字の次のインデックス。これは start より大きくなければならない

戻り値:

start から始まり、limit までの (ただし limit は含まない) 文字の TextLayout

例外:

IndexOutOfBoundsException - limit が start より前の場合

IllegalArgumentException - start または limit が段落の開始位置と終了位置の間にない場合。

insertChar

public void insertChar(AttributedCharacterIterator newParagraph,
              int insertPos)

この TextMeasurer が現在表すパラグラフへ 1 文字を挿入してから TextMeasurer を更新します。この呼び出しのあと、TextMeasurer は、テキストから作成された新しい TextMeasurer と同等になります。しかし、通常は、まったくゼロから新しいものを作成するより既存の TextMeasurer を更新した方が効率的です。

パラメータ:

newParagraph - 挿入を実行した後の段落のテキスト。null は不可。

insertPos - テキスト内の、文字が挿入された位置。newParagraph の開始位置以降で、newParagraph の終了位置より前。

例外:

IndexOutOfBoundsException - insertPos が newParagraph の開始位置より前、または newParagraph の終了位置と同じか、それより後ろである場合

NullPointerException - newParagraph が null である場合

deleteChar

public void deleteChar(AttributedCharacterIterator newParagraph,
              int deletePos)

この TextMeasurer が現在表すパラグラフで 1 文字を削除してから TextMeasurer を更新します。この呼び出しのあと、TextMeasurer は、テキストから作成された新しい TextMeasurer と同等になります。しかし、通常は、まったくゼロから新しいものを作成するより既存の TextMeasurer を更新した方が効率的です。

パラメータ:

newParagraph - 削除を実行した後の段落のテキスト。null は不可。

deletePos - テキスト内の、文字が削除された位置。newParagraph の開始位置以降で、newParagraph の終了位置を超えない。

例外:

IndexOutOfBoundsException - deletePos が newParagraph の開始位置より前、または newParagraph の終了位置より後ろである場合

NullPointerException - newParagraph が null である場合