org.fife.ui.rtextfilechooser.IconsView Maven / Gradle / Ivy

/*
 * 07/14/2004
 *
 * IconsView.java - The "Icons view" for an RTextFileChooser.
 * Copyright (C) 2004 Robert Futrell
 * http://fifesoft.com/rtext
 * Licensed under a modified BSD license.
 * See the included license file for details.
 */
package org.fife.ui.rtextfilechooser;

import java.awt.*;
import java.awt.event.*;
import java.beans.PropertyVetoException;
import java.io.File;
import java.util.Vector;
import javax.swing.*;
import javax.swing.event.MouseInputAdapter;
import javax.swing.plaf.DesktopPaneUI;
import javax.swing.plaf.InternalFrameUI;
import javax.swing.plaf.basic.*;
import javax.swing.text.Segment;
import javax.swing.text.Utilities;


/**
 * An icons view for a file chooser similar to the "Icons" view found in
 * Microsoft Windows file choosers.
 * Note that this class is NOT efficient when compared to other file chooser
 * view such as ListView and DetailsView because it
 * does not paint its "files" via a renderer; rather, all files are represented
 * by separate Components.  This ends up taking a huge amount of
 * memory when viewing many files.
 *
 * @author Robert Futrell
 * @version 0.2
 */
class IconsView extends IconDesktopPane implements RTextFileChooserView {

	private static final int SPACING			= 10;	// Spacing between icons.
	private static final int DEFAULT_ICON_WIDTH	= 64;
	private static final int DEFAULT_ROW_SIZE	= 5;		// Default # of icons per row.

	private RTextFileChooser chooser;
	private Color selectionForeground;
	private Color selectionBackground;
	private MouseListener mouseListener;


	/**
	 * Constructor.
	 *
	 * @param chooser The owning file chooser.
	 */
	public IconsView(RTextFileChooser chooser) {

		this.chooser = chooser;
		setImportantColors();

		ComponentOrientation orientation = chooser.getComponentOrientation();
		applyComponentOrientation(orientation);

		// Add any listeners.
		mouseListener = new MouseListener(chooser);
		addMouseListener(mouseListener);
		addComponentListener(new ComponentAdapter() {
						public void componentShown(ComponentEvent e) {
							refresh();// This makes icons organized neatly on first appearance.
						}
						});

	}


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

		// Selected files are kept in a separate array so we clear them separately.
		clearSelection();

		Component[] components = getComponents();
		int componentCount = components.length;
		for (int i=0; i0)
			repaint();
	}


	/**
	 * Makes sure there are no selected files in this view.
	 */
	public void clearSelection() {
		JInternalFrame[] frames = getSelectedFrames();
		if (frames==null)
			return;
		int count = frames.length;
		for (int i=0; inull if there isn't
	 *         one???  This may very-well be view-dependent).
	 */
	public File getFileAtPoint(Point p) {
		Component c = getComponentAt(p);
		if (c instanceof IconInternalFrame)
			return ((IconInternalFrame)c).getFile();
		return null;
	}


	/**
	 * Gets the selected file, for use when a single file is selected.
	 *
	 * @return The selected file, or null if no file is
	 *         selected.
	 */
	public File getSelectedFile() {
		IconInternalFrame frame = (IconInternalFrame)getSelectedFrame();
		if (frame!=null)
			return frame.getFile();
		return null;
	}


	/**
	 * Returns all selected files in this view.
	 *
	 * @return An array of all selected files.
	 */
	public File[] getSelectedFiles() {
		JInternalFrame[] frames = getSelectedFrames();
		File[] files = null;
		if (frames!=null) {
			int num = frames.length;
			files = new File[num];
			for (int i=0; iwidth) {
				x = SPACING;
				y += frames[i].getHeight() + SPACING;
			}
		}

		size.height = y+DEFAULT_ICON_WIDTH;
		setPreferredSize(size);
		setSize(size);			// Causes the scroll pane to revalidate.

	}


	/**
	 * Removes all listeners this view has created and added to itself.  This
	 * method is here to get around the fact that finalize 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.
	 */
	public void removeAllListeners() {
		clearDisplayedFiles(); // Just in case.
		removeMouseListener(mouseListener);
	}


	/**
	 * 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) {
		clearSelection();
		Component c = getComponentAt(p);
		if (c instanceof IconInternalFrame) { // could return "this".
			IconInternalFrame frame = (IconInternalFrame)c;
			addSelectedFrame(frame);
			try {
				frame.setSelected(true);
			} catch (PropertyVetoException pve) {}
		}
	}


	/**
	 * 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) {

		// Clears view and also clears "selected files" vector.
		clearDisplayedFiles();

		int num = files.size();
		for (int i=0; icurrentDirectory, then
	 *        they are not selected.
	 */
	public void setSelectedFiles(File[] files) {

		clearSelection();

		int componentCount = getComponentCount();
		int numToSelect = files.length;

		for (int i=0; i0)
					result += "
";
				count++;
			} while (fileName.length()>0);

			// Make sure the icon is big enough to display all the text...
			setSize(DEFAULT_ICON_WIDTH, defaultHeight+(count-1)*fm.getHeight());

			return result;

		}

		public void setSelected(boolean selected) throws PropertyVetoException {

			super.setSelected(selected);

			// Have the text field/combo box updated too.
			chooser.synchronizeTextFieldWithView();

			if (selected) {

				// Set colors.
				label.setForeground(selectionForeground);

				// Set text to display.
				String text = file.getName();
				String beginning = null, ending = null;
				if (chooser.isOpenedFile(file) && chooser.getStyleOpenFiles()) {
					beginning = "
";
					ending = "";
				}
				else {
					beginning = "";
					ending = "";
				}

				label.setText(beginning + getHTMLFileName(text) + ending);

			}
			// FIXME:  Underlining messes up view due to implied  usage...
			else {
				// Set colors and text to display.
				label.setForeground(unselectedFG);
				String beginning = null, ending = null;
				if (chooser.isOpenedFile(file)) {
					beginning = "";//"";
					ending = "";//"";
				}
				else {
					beginning = "";
					ending = "";
				}
				label.setText(beginning + file.getName() + ending);
				setSize(DEFAULT_ICON_WIDTH, defaultHeight);
			}
		}

		// Overridden to always have our special UI.
		public void setUI(InternalFrameUI ui) {
			super.setUI(new BasicInternalFrameUI(this) {
					protected MouseInputAdapter createBorderListener(JInternalFrame w) {
						return null;
					}
					protected void installMouseHandlers(JComponent c) {
					}
					});
			setRootPaneCheckingEnabled(false);
			((BasicInternalFrameUI)getUI()).setNorthPane(null);
			setRootPaneCheckingEnabled(true);
		}

		// _x & _y are the mousePressed location in absolute coordinate system
		int _x, _y;
		// __x & __y are the mousePressed location in source view's coordinate system
		int __x, __y;
		Rectangle startingBounds;

		public void mousePressed(MouseEvent e) {

			int modifiers = e.getModifiers();
			if ((modifiers&InputEvent.BUTTON1_MASK)==InputEvent.BUTTON1_MASK) {

				Point p = SwingUtilities.convertPoint(this,
											e.getX(), e.getY(), null);
				__x = e.getX();
				__y = e.getY();
				_x = p.x;
				_y = p.y;
				startingBounds = getBounds();

				// If multiselection isn't enabled, or if they don't hold
				// down shift or control while clicking, we need to clear
				// the selection.
				if (!chooser.isMultiSelectionEnabled() ||
					((modifiers&InputEvent.SHIFT_MASK)==0 &&
					 (modifiers&InputEvent.CTRL_MASK)==0))
				{
					clearSelection();
				}

				// Now, select this newly-clicked on file.
				try {
					setSelected(true);
				} catch (PropertyVetoException e1) { }

				Insets i = getInsets();

				Point ep = new Point(__x, __y);

				if (ep.x > i.left && ep.y > i.top && ep.x < getWidth() - i.right) {
					getDesktopManager().beginDraggingFrame(this);
				}

			} // End of if ((e.getModifiers()&InputEvent.BUTTON1_MASK)!=0)

		}


		public void mouseReleased(MouseEvent e) {

			int modifiers = e.getModifiers();

			// If they just released a left-click, stop any dragging.
			if ((modifiers&InputEvent.BUTTON1_MASK)!=0) {
				getDesktopManager().endDraggingFrame(this);	
				_x = 0;
				_y = 0;
				__x = 0;
				__y = 0;
				startingBounds = null;
			}

			// If they just released a right-click, select the item under the
			// mouse.  This check is because of the internal frames and their
			// labels evidently not sending out mouseClicked events unless
			// they are clicked when they already have focus...
			else {

				// If they clicked on a label and not the icons view, we need to
				// convert the click-point to the proper space.
				Point p = e.getPoint();
				Component source = (Component)e.getSource(); // Always an internal frame?
				if (source!=IconsView.this)
					p = SwingUtilities.convertPoint(source, p, IconsView.this);

				// Pretend like the view is the one who received the mouse click,
				// not the internal frame.  Also pretend like it's a click-
				// event and not a release-event, so the popup menu appears.
				mouseListener.mouseClicked(
					new MouseEvent(IconsView.this, MouseEvent.MOUSE_CLICKED,
								e.getWhen(), e.getModifiers(),
								p.x,p.y, 1,
								e.isPopupTrigger(), e.getButton())
				);

			}

		}

		public void mouseDragged(MouseEvent e) {   
			if ( startingBounds == null ) {
				// (STEVE) Yucky work around for bug ID 4106552
				return;
			}
                                     
			Point p = SwingUtilities.convertPoint(this,
										e.getX(), e.getY(), null);
			int deltaX = _x - p.x;
			int deltaY = _y - p.y;
			int newX, newY;
			Insets i = getInsets();
        
			// Move the window.
			if ((e.getModifiers()&InputEvent.BUTTON1_MASK)!=InputEvent.BUTTON1_MASK) {
    	               // don't allow moving of frames if the left mouse
    	               // button was not used.
    	               return;
			}

			int pWidth, pHeight;
			Dimension s = getParent().getSize();
			pWidth = s.width;
			pHeight = s.height;


			newX = startingBounds.x - deltaX;
			newY = startingBounds.y - deltaY;

			// Make sure we stay in-bounds
			if(newX + i.left <= -__x)
				newX = -__x - i.left + 1;
			if(newY + i.top <= -__y)
				newY = -__y - i.top + 1;
			if(newX + __x + i.right >= pWidth)
				newX = pWidth - __x - i.right - 1;
			if(newY + __y + i.bottom >= pHeight)
				newY =  pHeight - __y - i.bottom - 1;

			getDesktopManager().dragFrame(this, newX, newY);

		}

		public void mouseMoved(MouseEvent e) {
		}

		public void mouseEntered(MouseEvent e) {
		}

		public void mouseExited(MouseEvent e) {
		}

		public void mouseClicked(MouseEvent e) {

			// If they clicked on a label and not the icons view, we need to
			// convert the click-point to the proper space.
			Point p = e.getPoint();
			Component source = (Component)e.getSource(); // Always an internal frame?
			if (source!=IconsView.this)
				p = SwingUtilities.convertPoint(source, p, IconsView.this);

			// Pretend like the view is the one who received the mouse click,
			// not the internal frame.
			mouseListener.mouseClicked(
				new MouseEvent(IconsView.this, e.getID(), e.getWhen(), e.getModifiers(),
							p.x,p.y, e.getClickCount(),
							e.isPopupTrigger(), e.getButton())
			);

		}

		// This is only called for the internal frame itself, not its JLabel,
		// so we never really see it called.  But it's still safe to have it,
		// and it prevents other listeners from hearin' stuff.
		public void processMouseEvent(MouseEvent e) {
			switch (e.getID()) {
				case MouseEvent.MOUSE_PRESSED:
					mousePressed(e);
					return;
				case MouseEvent.MOUSE_RELEASED:
					mouseReleased(e);
					return;
				case MouseEvent.MOUSE_CLICKED:
					mouseClicked(e);
			}
			//super.processMouseEvent(e); // Don't need this...
		}

		public void processMouseMotionEvent(MouseEvent e) {
			switch (e.getID()) {
				case MouseEvent.MOUSE_DRAGGED:
					mouseDragged(e);
					return;
			}
			//super.processMouseMotionEvent(e); // Don't need this...
		}

		public String toString() {
			return "[IconInternalFrame: file==" + getFile() + "]";
		}

	}


}