java.awt.font
クラス TextHitInfo

java.lang.Object
  |
  +--java.awt.font.TextHitInfo

public final class TextHitInfo

extends Object

TextHitInfo クラスは、テキストモデル内の文字の位置、およびその文字の「バイアス (サイド)」を表します。バイアスは、「リーディング (左から右に記述する文字の左端)」または「トレーリング (左から右に記述する文字の右端) のどちらかです。TextHitInfo のインスタンスは、テキスト内のキャレットおよび挿入位置を指定するために使用されます。

たとえば、テキストの「abc」を考えてください。TextHitInfo.trailing(1) は、そのテキストの「b」の右側に対応します。

TextHitInfo は、主に TextLayout および TextLayout のクライアントによって使用されます。TextLayout のクライアントは、TextHitInfo のインスタンスに挿入オフセットを問い合わせます。挿入オフセットとは、テキストモデル内で新しいテキストが挿入される位置です。挿入オフセットは、バイアスがリーディングの場合は TextHitInfo の文字の位置と等しく、バイアスがトレーリングの場合は 1 文字分あとの位置になります。TextHitInfo.trailing(1) の挿入オフセットは 2 です。

TextHitInfo の作成は、既存のものと同じ挿入オフセット、ただし反対の文字で行うと便利な場合があります。getOtherHit メソッドは、既存のものと同じ挿入オフセット、挿入オフセットの反対側の文字のヒットで新しい TextHitInfo を作成します。trailing(1) で getOtherHit を呼び出すと、leading(2) が返されます。一般に、trailing(n) での getOtherHit は leading(n+1) を返し、leading(n) での getOtherHit は trailing(n-1) を返します。

例:

グラフィックの点をテキストモデル内の挿入ポイントに変換します。

 TextLayout layout = ...;
 Point2D.Float hitPoint = ...;
 TextHitInfo hitInfo = layout.hitTestChar(hitPoint.x, hitPoint.y);
 int insPoint = hitInfo.getInsertionIndex();
 // insPoint is relative to layout;  may need to adjust for use 
 // in a text model
 

関連項目:

TextLayout

メソッドの概要

static TextHitInfo	afterOffset(int offset) オフセットのあとの文字に関連付けられている指定されたオフセットで TextHitInfo を作成します。
static TextHitInfo	beforeOffset(int offset) オフセットの前の文字に関連付けられている指定されたオフセットで TextHitInfo を作成します。
boolean	equals(Object obj) 指定された Object が TextHitInfo であり、この TextHitInfo と等しい場合に true を返します。
boolean	equals(TextHitInfo hitInfo) 指定された TextHitInfo がこの TextHitInfo と同じ charIndex および isLeadingEdge を持つ場合に true を返します。
int	getCharIndex() 文字ヒットのインデックスを返します。
int	getInsertionIndex() 挿入インデックスを返します。
TextHitInfo	getOffsetHit(int delta) この charIndex から delta だけオフセットした文字インデックスを持つ TextHitInfo を作成します。
TextHitInfo	getOtherHit() 挿入ポイントの反対側で TextHitInfo を作成します。
int	hashCode() ハッシュコードを返します。
boolean	isLeadingEdge() 文字のリーディングエッジがヒットされた場合に true を返します。
static TextHitInfo	leading(int charIndex) 指定された charIndex にある文字のリーディングエッジで TextHitInfo を作成します。
String	toString() ヒットを表す String を返します。
static TextHitInfo	trailing(int charIndex) 指定された charIndex にある文字のトレーリングエッジでヒットを作成します。

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

メソッドの詳細

getCharIndex

public int getCharIndex()

文字ヒットのインデックスを返します。

戻り値:

文字ヒットのインデックス

isLeadingEdge

public boolean isLeadingEdge()

文字のリーディングエッジがヒットされた場合に true を返します。

戻り値:

文字のリーディングエッジがヒットされた場合は true、そうでない場合は false

getInsertionIndex

public int getInsertionIndex()

挿入インデックスを返します。これは、文字のリーディングエッジがヒットされた場合は文字インデックスとなり、トレーリングエッジがヒットされた場合には文字インデックスより 1 大きい値となります。

戻り値:

挿入インデックス

hashCode

public int hashCode()

ハッシュコードを返します。

オーバーライド:

クラス Object 内の hashCode

戻り値:

この TextHitInfo のハッシュコード。この TextHitInfo の charIndex でもある

equals

public boolean equals(Object obj)

指定された Object が TextHitInfo であり、この TextHitInfo と等しい場合に true を返します。

オーバーライド:

クラス Object 内の equals

パラメータ:

obj - 等しいかどうかが判定される Object

戻り値:

指定された Object がこの TextHitInfo と等しい場合は true、そうでない場合は false

equals

public boolean equals(TextHitInfo hitInfo)

指定された TextHitInfo がこの TextHitInfo と同じ charIndex および isLeadingEdge を持つ場合に true を返します。これは、同じ挿入オフセットを持つことと同じではありません。

パラメータ:

hitInfo - TextHitInfo

戻り値:

指定された TextHitInfo がこの TextHitInfo と同じ charIndex および isLeadingEdge を持つ場合は true

toString

public String toString()

ヒットを表す String を返します。デバッグ用にだけ使用されます。

オーバーライド:

クラス Object 内の toString

戻り値:

この TextHitInfo を表す String

leading

public static TextHitInfo leading(int charIndex)

指定された charIndex にある文字のリーディングエッジで TextHitInfo を作成します。

パラメータ:

charIndex - 文字ヒットのインデックス

戻り値:

指定された charIndex にある文字のリーディングエッジの TextHitInfo

trailing

public static TextHitInfo trailing(int charIndex)

指定された charIndex にある文字のトレーリングエッジでヒットを作成します。

パラメータ:

charIndex - 文字ヒットのインデックス

戻り値:

指定された charIndex にある文字のトレーリングエッジの TextHitInfo

beforeOffset

public static TextHitInfo beforeOffset(int offset)

オフセットの前の文字に関連付けられている指定されたオフセットで TextHitInfo を作成します。

パラメータ:

offset - オフセットの前の文字に関連付けられているオフセット

戻り値:

指定されたオフセットの TextHitInfo

afterOffset

public static TextHitInfo afterOffset(int offset)

オフセットのあとの文字に関連付けられている指定されたオフセットで TextHitInfo を作成します。

パラメータ:

offset - オフセットのあとの文字に関連付けられているオフセット

戻り値:

指定されたオフセットの TextHitInfo

getOtherHit

public TextHitInfo getOtherHit()

挿入ポイントの反対側で TextHitInfo を作成します。この TextHitInfo は変わりません。

戻り値:

挿入ポイントの反対側の TextHitInfo

getOffsetHit

public TextHitInfo getOffsetHit(int delta)

この charIndex から delta だけオフセットした文字インデックスを持つ TextHitInfo を作成します。この TextHitInfo は変わりません。

パラメータ:

delta - この charIndex に対するオフセット値

戻り値:

この TextHitInfo の charIndex から delta だけオフセットした charIndex を持つ TextHitInfo