blob: fdbdf3501777b52e9a9d2eb6bdf23324f7d7cc48 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25package javax.accessibility;
26
27
28/**
29 * <P>The AccessibleTextSequence provides information about
30 * a contiguous sequence of text.
31 *
32 * @see Accessible
33 * @see Accessible#getAccessibleContext
34 * @see AccessibleContext
35 * @see AccessibleContext#getAccessibleText
36 * @see AccessibleAttributeSequence
37 *
38 * @author Lynn Monsanto
39 */
40
41/**
42 * This class collects together key details of a span of text. It
43 * is used by implementors of the class <code>AccessibleExtendedText</code> in
44 * order to return the requested triplet of a <code>String</code>, and the
45 * start and end indicies/offsets into a larger body of text that the
46 * <code>String</code> comes from.
47 *
48 * @see javax.accessibility.AccessibleExtendedText
49 */
50public class AccessibleTextSequence {
51
52 /* The start index of the text sequence */
53 public int startIndex;
54
55 /** The end index of the text sequence */
56 public int endIndex;
57
58 /** The text */
59 public String text;
60
61 /**
62 * Constructs an <code>AccessibleTextSequence</code> with the given
63 * parameters.
64 *
65 * @param start the beginning index of the span of text
66 * @param end the ending index of the span of text
67 * @param txt the <code>String</code> shared by this text span
68 *
69 * @since 1.6
70 */
71 public AccessibleTextSequence(int start, int end, String txt) {
72 startIndex = start;
73 endIndex = end;
74 text = txt;
75 }
76};