org.apache.batik.gvt.text
Class TextHit

java.lang.Object
  |
  +--org.apache.batik.gvt.text.TextHit

public class TextHit
extends java.lang.Object

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

See Also:
org.apache.batik.gvt.text.TextSpanLayout.

Constructor Summary
TextHit(int charIndex, boolean leadingEdge)
          Constructs a TextHit with the specified values.
 
Method Summary
 int getCharIndex()
          Returns the index of the character that has been hit.
 java.awt.font.FontRenderContext getFontRenderContext()
          Returns the font render context at the time of the text hit.
 TextNode getTextNode()
          Returns the text node associated with this text hit.
 boolean isLeadingEdge()
          Returns whether on not the character has been hit on its leading edge.
 void setFontRenderContext(java.awt.font.FontRenderContext frc)
          Sets the font render context at the time of the hit.
 void setTextNode(TextNode textNode)
          Sets the TextNode that is associated with this hit.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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.

setTextNode

public void setTextNode(TextNode textNode)
Sets the TextNode that is associated with this hit.
Parameters:
textNode - The textNode that has been hit.

setFontRenderContext

public void setFontRenderContext(java.awt.font.FontRenderContext frc)
Sets the font render context at the time of the hit.
Parameters:
frc - The current font render context.

getTextNode

public TextNode getTextNode()
Returns the text node associated with this text hit.
Returns:
The text node that has been hit.

getFontRenderContext

public java.awt.font.FontRenderContext getFontRenderContext()
Returns the font render context at the time of the text hit.
Returns:
The font render context.


Copyright © 2001 Apache Software Foundation. All Rights Reserved.