01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: *
41: * Contributor(s): Ivan Soleimanipour.
42: */
43:
44: /*
45: * "LogicalLineVisitor.java"
46: * LogicalLineVisitor.java 1.1 01/07/24
47: */
48:
49: package org.netbeans.lib.terminalemulator;
50:
51: /**
52: * Passed to one of visitLogicalLines() or reverseVisitLogicalLines().
53: */
54:
55: public interface LogicalLineVisitor {
56: /**
57: * Called for each logical line.
58: * <p>
59: * 'text' contains the actual text of a complete line which may be
60: * wrapped multiple times. 'begin' and 'end' mark the region.
61: * <p>
62: * Note that for the first line 'begin' will match the 'begin' passed to
63: * visitLogicalLines(), so watch out if you specify a visitation range
64: * that starts in the middle of a line.
65: * <p>
66: * Normally end.row == begin.row, but if the logical line was wrapped,
67: * end.row > begin.row.
68: * <p>
69: * 'line' is intended to represent a line number, however if the
70: * visitation range isn't the whole document it should be interpreted only
71: * as a serial number and in the case of reverseVisitLogicalLines() the
72: * sequence of line numbers will be backwards.
73: * <p>
74: * If you locate something in 'text' and need to convert it back to
75: * a Coord use extentInLogicalLine().
76: */
77:
78: public boolean visit(int line, Coord begin, Coord end, String text);
79: }
|