TextHitInfo
class represents a character position in a
text model, and a bias, or "side," of the character. Biases are
either leading (the left edge, for a left-to-right character)
or trailing (the right edge, for a left-to-right character).
Instances of TextHitInfo
are used to specify caret and
insertion positions within text.
For example, consider the text "abc". TextHitInfo.trailing(1) corresponds to the right side of the 'b' in the text.
TextHitInfo
is used primarily by TextLayout
and
clients of TextLayout
. Clients of TextLayout
query TextHitInfo
instances for an insertion offset, where
new text is inserted into the text model. The insertion offset is equal
to the character position in the TextHitInfo
if the bias
is leading, and one character after if the bias is trailing. The
insertion offset for TextHitInfo.trailing(1) is 2.
Sometimes it is convenient to construct a TextHitInfo
with
the same insertion offset as an existing one, but on the opposite
character. The getOtherHit
method constructs a new
TextHitInfo
with the same insertion offset as an existing
one, with a hit on the character on the other side of the insertion offset.
Calling getOtherHit
on trailing(1) would return leading(2).
In general, getOtherHit
for trailing(n) returns
leading(n+1) and getOtherHit
for leading(n)
returns trailing(n-1).
Example:
Converting a graphical point to an insertion point within a text model
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
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic TextHitInfo
afterOffset
(int offset) Creates aTextHitInfo
at the specified offset, associated with the character after the offset.static TextHitInfo
beforeOffset
(int offset) Creates aTextHitInfo
at the specified offset, associated with the character before the offset.boolean
equals
(TextHitInfo hitInfo) Returnstrue
if the specifiedTextHitInfo
has the samecharIndex
andisLeadingEdge
as thisTextHitInfo
.boolean
Returnstrue
if the specifiedObject
is aTextHitInfo
and equals thisTextHitInfo
.int
Returns the index of the character hit.int
Returns the insertion index.getOffsetHit
(int delta) Creates aTextHitInfo
whose character index is offset bydelta
from thecharIndex
of thisTextHitInfo
.Creates aTextHitInfo
on the other side of the insertion point.int
hashCode()
Returns the hash code.boolean
Returnstrue
if the leading edge of the character was hit.static TextHitInfo
leading
(int charIndex) Creates aTextHitInfo
on the leading edge of the character at the specifiedcharIndex
.toString()
Returns aString
representing the hit for debugging use only.static TextHitInfo
trailing
(int charIndex) Creates a hit on the trailing edge of the character at the specifiedcharIndex
.
-
Method Details
-
getCharIndex
public int getCharIndex()Returns the index of the character hit.- Returns:
- the index of the character hit.
-
isLeadingEdge
public boolean isLeadingEdge()Returnstrue
if the leading edge of the character was hit.- Returns:
true
if the leading edge of the character was hit;false
otherwise.
-
getInsertionIndex
public int getInsertionIndex()Returns the insertion index. This is the character index if the leading edge of the character was hit, and one greater than the character index if the trailing edge was hit.- Returns:
- the insertion index.
-
hashCode
-
equals
-
equals
Returnstrue
if the specifiedTextHitInfo
has the samecharIndex
andisLeadingEdge
as thisTextHitInfo
. This is not the same as having the same insertion offset.- Parameters:
hitInfo
- a specifiedTextHitInfo
- Returns:
true
if the specifiedTextHitInfo
has the samecharIndex
andisLeadingEdge
as thisTextHitInfo
.
-
toString
-
leading
Creates aTextHitInfo
on the leading edge of the character at the specifiedcharIndex
.- Parameters:
charIndex
- the index of the character hit- Returns:
- a
TextHitInfo
on the leading edge of the character at the specifiedcharIndex
.
-
trailing
Creates a hit on the trailing edge of the character at the specifiedcharIndex
.- Parameters:
charIndex
- the index of the character hit- Returns:
- a
TextHitInfo
on the trailing edge of the character at the specifiedcharIndex
.
-
beforeOffset
Creates aTextHitInfo
at the specified offset, associated with the character before the offset.- Parameters:
offset
- an offset associated with the character before the offset- Returns:
- a
TextHitInfo
at the specified offset.
-
afterOffset
Creates aTextHitInfo
at the specified offset, associated with the character after the offset.- Parameters:
offset
- an offset associated with the character after the offset- Returns:
- a
TextHitInfo
at the specified offset.
-
getOtherHit
Creates aTextHitInfo
on the other side of the insertion point. ThisTextHitInfo
remains unchanged.- Returns:
- a
TextHitInfo
on the other side of the insertion point.
-
getOffsetHit
Creates aTextHitInfo
whose character index is offset bydelta
from thecharIndex
of thisTextHitInfo
. ThisTextHitInfo
remains unchanged.- Parameters:
delta
- the value to offset thischarIndex
- Returns:
- a
TextHitInfo
whosecharIndex
is offset bydelta
from thecharIndex
of thisTextHitInfo
.
-