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) が返されます。一般に、トレーリングに対する getOtherHit は leading(n+1) を返し、リーディングに対する 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 の charIndex および isLeadingEdge がこの TextHitInfo と同じ場合に true を返します。
int	getCharIndex() 文字ヒットのインデックスを返します。
int	getInsertionIndex() 挿入インデックスを返します。
TextHitInfo	getOffsetHit(int delta) 文字インデックスが、この TextHitInfo の 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()

挿入インデックスを返します。これは、文字のリーディングエッジがヒットであった場合の文字インデックスであり、トレーリングエッジがヒットであった場合の文字インデックスより大きくなります。

戻り値:

挿入インデックス

hashCode

public int hashCode()

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

オーバーライド:

クラス Object 内の hashCode

戻り値:

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

関連項目:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object obj)

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

オーバーライド:

クラス Object 内の equals

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode(), Hashtable

equals

public boolean equals(TextHitInfo hitInfo)

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

パラメータ:

hitInfo - 指定された TextHitInfo

戻り値:

指定された TextHitInfo の charIndex および isLeadingEdge がこの TextHitInfo と同じ場合は 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)

文字インデックスが、この TextHitInfo の charIndex からの delta によるオフセットである TextHitInfo を作成します。この TextHitInfo は変更されません。

パラメータ:

delta - この charIndex のオフセットを設定する値

戻り値:

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