/*
 *                      Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License Version
 * 1.0 (the "License"). You may not use this file except in compliance
 * with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is Terminal Emulator.
 * The Initial Developer of the Original Code is Sun Microsystems, Inc..
 * Portions created by Sun Microsystems, Inc. are Copyright (C) 2001.
 * All Rights Reserved.
 *
 * Contributor(s): Ivan Soleimanipour.
 */

/*
 * "LogicalLineVisitor.java"
 * LogicalLineVisitor.java 1.1 01/07/24
 */

package org.netbeans.lib.terminalemulator;

/**
 * Passed to one of visitLogicalLines() or reverseVisitLogicalLines().
 */

public interface LogicalLineVisitor {
    /**
     * Called for each logical line.
     * 

     * 'text' contains the actual text of a complete line which may be 
     * wrapped multiple times. 'begin' and 'end' mark the region.
     * 

     * Note that for the first line 'begin' will match the 'begin' passed to
     * visitLogicalLines(), so watch out if you specify a visitation range
     * that starts in the middle of a line.
     * 

     * Normally end.row == begin.row, but if the logical line was wrapped,
     * end.row > begin.row.
     * 

     * 'line' is intended to represent a line number, however if the
     * visitation range isn't the whole document it should be interpreted only
     * as a serial number and in the case of reverseVisitLogicalLines() the
     * sequence of line numbers will be backwards.
     * 

     * If you locate something in 'text' and need to convert it back to 
     * a Coord use extentInLogicalLine().
     */

    public boolean visit(int line, Coord begin, Coord end, String text);
}