org.fife.ui.search.ResultsComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rtext Show documentation
Show all versions of rtext Show documentation
RText is a powerful, cross-platform programmer's text editor written in Java. It is designed
to be easy to use, highly customizable and flexible. Part of RText's design is for the source code
to be simple, easy to understand, and well documented, so that other programmers can look into its
inner-workings and figure out how RText ticks with ease. A good place to start (besides the source
code) is the Javadoc for all classes used in the project.
/*
* 09/19/2006
*
* ResultsComponent.java - A component displaying search/replace results.
* Copyright (C) 2006 Robert Futrell
* http://fifesoft.com/rtext
* Licensed under a modified BSD license.
* See the included license file for details.
*/
package org.fife.ui.search;
/**
* Interface that identifies a component that displays search or
* replace information in a FindInFilesDialog or
* ReplaceInFilesDialog.
*
* @author Robert Futrell
* @version 1.0
*/
interface ResultsComponent {
/**
* Adds data on a match to the component.
*
* @param matchData The data.
* @param dirName The "root directory" searching was done in. This is
* used so all file paths displayed in are abbreviated to be
* relative to this directory.
* @see #clear()
*/
public void addMatchData(MatchData matchData, String dirName);
/**
* Clears all match results from the table.
*
* @see #addMatchData(MatchData, String)
*/
public void clear();
/**
* Returns the match data displayed in the specified row.
*
* @param row The row.
* @return The match data.
*/
public MatchData getMatchDataForRow(int row);
/**
* Returns the number of rows displayed in this component.
*
* @return The number of rows displayed.
*/
public int getRowCount();
/**
* Returns the row selected, or -1 if none.
*
* @return The row selected.
*/
public int getSelectedRow();
/**
* Allows the results component to update its appearance after
* having lots of data added to it.
*/
public void prettyUp();
}