org.apache.batik.gvt.text

Class TextHit

public class TextHit extends Object

Class that encapsulates information returned from hit testing a TextSpanLayout instance.

See Also:

Constructor Summary
TextHit(int charIndex, boolean leadingEdge)
Constructs a TextHit with the specified values.
Method Summary
intgetCharIndex()
Returns the index of the character that has been hit.
booleanisLeadingEdge()
Returns whether on not the character has been hit on its leading edge.

Constructor Detail

TextHit

public TextHit(int charIndex, boolean leadingEdge)
Constructs a TextHit with the specified values.

Parameters: charIndex The index of the character that has been hit. In the case of bidirectional text this will be the logical character index not the visual index. The index is relative to whole text within the selected TextNode. leadingEdge Indicates which side of the character has been hit.

Method Detail

getCharIndex

public int getCharIndex()
Returns the index of the character that has been hit.

Returns: The character index.

isLeadingEdge

public boolean isLeadingEdge()
Returns whether on not the character has been hit on its leading edge.

Returns: Whether on not the character has been hit on its leading edge.

Copyright B) 2007 Apache Software Foundation. All Rights Reserved.