KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > batik > gvt > text > TextHit


1 /*
2
3    Copyright 2000-2001,2003 The Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16
17  */
18 package org.apache.batik.gvt.text;
19
20
21 /**
22  * Class that encapsulates information returned from hit testing
23  * a <tt>TextSpanLayout</tt> instance.
24  * @see org.apache.batik.gvt.text.TextSpanLayout
25  *
26  * @author <a HREF="mailto:bill.haneman@ireland.sun.com">Bill Haneman</a>
27  * @version $Id: TextHit.java,v 1.13 2005/03/27 08:58:35 cam Exp $
28  */
29 public class TextHit {
30
31     private int charIndex;
32     private boolean leadingEdge;
33
34     /**
35      * Constructs a TextHit with the specified values.
36      *
37      * @param charIndex The index of the character that has been
38      * hit. In the case of bidirectional text this will be the logical
39      * character index not the visual index. The index is relative to
40      * whole text within the selected TextNode.
41      * @param leadingEdge Indicates which side of the character has
42      * been hit.
43      */
44     public TextHit(int charIndex, boolean leadingEdge) {
45         this.charIndex = charIndex;
46         this.leadingEdge = leadingEdge;
47     }
48
49     /**
50      * Returns the index of the character that has been hit.
51      *
52      * @return The character index.
53      */
54     public int getCharIndex() {
55         return charIndex;
56     }
57
58     /**
59      * Returns whether on not the character has been hit on its leading edge.
60      *
61      * @return Whether on not the character has been hit on its leading edge.
62      */
63     public boolean isLeadingEdge() {
64         return leadingEdge;
65     }
66 }
67
68
Popular Tags