LogicalLineVisitor (Terminal Emulator) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.lib.terminalemulator 1.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.lib.terminalemulator
Interface LogicalLineVisitor

public interface LogicalLineVisitor

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

Method Summary

boolean visit(int line, Coord begin, Coord end, String text)
Called for each logical line.

Method Summary
`boolean`	`visit(int line, Coord begin, Coord end, String text)` Called for each logical line.

Method Detail

visit

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

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().