rtextfilechooserview.java

具有不同语法高亮的编辑器实例

/*
 * 07/14/2004
 *
 * RTextFileChooserView.java - Specifies methods common to all RTextFileChooser
 *                             views.
 * Copyright (C) 2004 Robert Futrell
 * [e-mail]
 * www.website.com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package org.fife.ui.rtextfilechooser;

import java.awt.Point;
import java.io.File;
import java.util.Vector;


/**
 * Specifies methods common to all <code>RTextFileChooser</code> views.  The
 * goal is to abstract out enough information so that the
 * <code>RTextFileChooser</code> doesn't care what type of view it is showing;
 * it can just stick to a single API to refresh its file list, etc.
 *
 * @author Robert Futrell
 * @version 0.1
 */
interface RTextFileChooserView {


/*****************************************************************************/


	/**
	 * Clears all files displayed by this view.
	 */
	public void clearDisplayedFiles();


/*****************************************************************************/


	/**
	 * Makes sure there are no selected files in this view.
	 */
	public void clearSelection();


/*****************************************************************************/


	/**
	 * Makes sure the specified file is visible in the view.
	 *
	 * @param file The file that is to be visible.
	 */
	public void ensureFileIsVisible(File file);


/*****************************************************************************/


	/**
	 * Returns the number of files currently being displayed.
	 *
	 * @return The number of files currently being displayed.
	 */
	public int getDisplayedFileCount();


/*****************************************************************************/


	/**
	 * Returns the file at the specified point in the view.
	 *
	 * @param p The point at which to look for a file.
	 * @return The file at that point (or <code>null</code> if there isn't
	 *         one???  This may very-well be view-dependent).
	 */
	public File getFileAtPoint(Point p);


/*****************************************************************************/


	/**
	 * Gets the selected file, for use when a single file is selected.
	 *
	 * @return The selected file, or <code>null</code> if no file is
	 *         selected.
	 */
	public File getSelectedFile();


/*****************************************************************************/


	/**
	 * Returns all selected files in this view.
	 *
	 * @return An array of all selected files.
	 */
	public File[] getSelectedFiles();


/*****************************************************************************/


	/**
	 * Removes all listeners this view has created and added to itself.  This
	 * method is here to get around the fact that <code>finalize</code> is
	 * not going to be called as long as listeners are still registered for
	 * this view, but nobody else knows about these listeners except for the
	 * view.
	 */
	void removeAllListeners();


/*****************************************************************************/


	/**
	 * Selects the file at the specified point in the view.  If no file
	 * exists at that point, the selection should be cleared.
	 *
	 * @param p The point at which a file should be selected.
	 */
	public void selectFileAtPoint(Point p);


/*****************************************************************************/


	/**
	 * Sets the files displayed by this view.
	 *
	 * @param files A vector containing the files to display.  These files
	 *              are not necessarily sorted by file name.
	 */
	public void setDisplayedFiles(Vector files);


/*****************************************************************************/


	/**
	 * Sets whether or not this view allows the selection of multiple files.
	 *
	 * @param enabled Whether or not to allow the selection of multiple
	 *                files.
	 */
	public void setMultiSelectionEnabled(boolean enabled);


/*****************************************************************************/


	/**
	 * Selects the specified files in the view.
	 *
	 * @param files The files to select.  If any of the files are not in
	 *              the file chooser's <code>currentDirectory</code>, then
	 *              they are not selected.
	 */
	public void setSelectedFiles(File[] files);


/*****************************************************************************/

}