TextHitInfo (Java Platform SE 8)

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メソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッドと説明
`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)` 文字インデックスが、この`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()
```
    ハッシュ・コードを返します。
    
    オーバーライド:
    
    hashCode、クラス: Object
    
    戻り値:
    
    このTextHitInfoのハッシュ・コード。これはこのTextHitInfoのcharIndexでもある。
    
    関連項目:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(Object obj)
```
    指定されたObjectがTextHitInfoで、このTextHitInfoと等しい場合、trueを返します。
    
    オーバーライド:
    
    equals、クラス: Object
    
    パラメータ:
    
    obj - 等しいかどうかが判定されるObject
    
    戻り値:
    
    指定されたObjectがこのTextHitInfoの場合はtrue、それ以外の場合はfalse。
    
    関連項目:
    
    Object.hashCode()、HashMap
  - equals
```
public boolean equals(TextHitInfo hitInfo)
```
    指定されたTextHitInfoが、このTextHitInfoとして同じcharIndexとisLeadingEdgeを持つ場合、trueを返します。これは、挿入オフセットが同じであることとは異なります。
    
    パラメータ:
    
    hitInfo - 指定されたTextHitInfo
    
    戻り値:
    
    指定されたTextHitInfoのcharIndexおよびisLeadingEdgeがこのTextHitInfoと同じ場合はtrue。
  - toString
```
public String toString()
```
    デバッグ専用にヒットを表すStringを返します。
    
    オーバーライド:
    
    toString、クラス: Object
    
    戻り値:
    
    この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。

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

クラスTextHitInfo

メソッドのサマリー

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

メソッドの詳細

getCharIndex

isLeadingEdge

getInsertionIndex

hashCode

equals

equals

toString

leading

trailing

beforeOffset

afterOffset

getOtherHit

getOffsetHit