TextHitInfo JDK 1.6)

Description

publicfinal class TextHitInfo

The TextHitInfo class represents a character position in a text model, and a bias, or "side," of the character.

The 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: TextLayout

Methods

Hide/Show inherited methods

publicstatic TextHitInfo afterOffset (int offset)

Creates a TextHitInfo at the specified offset, associated with the character after the offset.

Creates a TextHitInfo at the specified offset,
associated with the character after the offset.
Returns: a TextHitInfo at the specified offset.
Parameters:
- offset - an offset associated with the character after the offset

publicstatic TextHitInfo beforeOffset (int offset)

Creates a TextHitInfo at the specified offset, associated with the character before the offset.

Creates a TextHitInfo at the specified offset,
associated with the character before the offset.
Returns: a TextHitInfo at the specified offset.
Parameters:
- offset - an offset associated with the character before the offset

public boolean equals (Object obj)

Returns true if the specified Object is a TextHitInfo and equals this TextHitInfo.

Returns true if the specified Object is a
TextHitInfo and equals this TextHitInfo.
Returns: true if the specified Object equals this TextHitInfo; false otherwise.
Parameters:
- obj - the Object to test for equality

public boolean equals (TextHitInfo hitInfo)

Returns true if the specified TextHitInfo has the same charIndex and isLeadingEdge as this TextHitInfo.

Returns true if the specified TextHitInfo
has the same charIndex and isLeadingEdge
as this TextHitInfo. This is not the same as having
the same insertion offset.
Returns: true if the specified TextHitInfo has the same charIndex and isLeadingEdge as this TextHitInfo.
Parameters:
- hitInfo - a specified TextHitInfo

public int getCharIndex ()

Returns the index of the character hit.

public int getInsertionIndex ()

Returns the insertion index.

public TextHitInfo getOffsetHit (int delta)

Creates a TextHitInfo whose character index is offset by delta from the charIndex of this TextHitInfo.

Creates a TextHitInfo whose character index is offset
by delta from the charIndex of this
TextHitInfo. This TextHitInfo remains
unchanged.
Returns: a TextHitInfo whose charIndex is offset by delta from the charIndex of this TextHitInfo.
Parameters:
- delta - the value to offset this charIndex

public TextHitInfo getOtherHit ()

Creates a TextHitInfo on the other side of the insertion point.

Creates a TextHitInfo on the other side of the
insertion point. This TextHitInfo remains unchanged.
Returns: a TextHitInfo on the other side of the insertion point.

public int hashCode ()

Returns the hash code.

Returns the hash code.
Returns: the hash code of this TextHitInfo, which is also the charIndex of this TextHitInfo.

public boolean isLeadingEdge ()

Returns true if the leading edge of the character was hit.

Returns true if the leading edge of the character was
hit.
Returns: true if the leading edge of the character was hit; false otherwise.

publicstatic TextHitInfo leading (int charIndex)

Creates a TextHitInfo on the leading edge of the character at the specified charIndex.

Creates a TextHitInfo on the leading edge of the
character at the specified charIndex.
Returns: a TextHitInfo on the leading edge of the character at the specified charIndex.
Parameters:
- charIndex - the index of the character hit

public String toString ()

Returns a String representing the hit for debugging use only.

Returns a String representing the hit for debugging
use only.
Returns: a String representing this TextHitInfo.

publicstatic TextHitInfo trailing (int charIndex)

Creates a hit on the trailing edge of the character at the specified charIndex.

Creates a hit on the trailing edge of the character at
the specified charIndex.
Returns: a TextHitInfo on the trailing edge of the character at the specified charIndex.
Parameters:
- charIndex - the index of the character hit