/*
 * Copyright (c) 2005-2009 Substance Kirill Grouchnikov. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 *  o Redistributions of source code must retain the above copyright notice, 
 *    this list of conditions and the following disclaimer. 
 *     
 *  o Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution. 
 *     
 *  o Neither the name of Substance Kirill Grouchnikov nor the names of 
 *    its contributors may be used to endorse or promote products derived 
 *    from this software without specific prior written permission. 
 *     
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */
package org.jvnet.substance;

import java.io.File;
import java.util.HashMap;
import java.util.Map;

import javax.swing.*;
import javax.swing.filechooser.FileView;
import javax.swing.plaf.ComponentUI;
import javax.swing.plaf.basic.BasicFileChooserUI;
import javax.swing.plaf.metal.MetalFileChooserUI;

import org.jvnet.substance.utils.SubstanceCoreUtilities;

/**
 * UI for file chooser in <b>Substance</b> look and feel. The
 * {@link BasicFileChooserUI} can't be used on its own (creates an empty
 * dialog).
 * 
 * @author Kirill Grouchnikov
 */
public class SubstanceFileChooserUI extends MetalFileChooserUI {
	/**
	 * Custom file view - for system icons on the files.
	 */
	private final SubstanceFileView fileView = new SubstanceFileView();

	/**
	 * Custom file view implementation that returns system-specific file icons.
	 * 
	 * @author Kirill Grouchnikov
	 */
	private class SubstanceFileView extends BasicFileView {
		/**
		 * Cache for the file icons.
		 */
		private final Map<String, Icon> pathIconCache = new HashMap<String, Icon>();

		/*
		 * (non-Javadoc)
		 * 
		 * @see
		 * javax.swing.plaf.basic.BasicFileChooserUI$BasicFileView#getCachedIcon
		 * (java.io.File)
		 */
		@Override
		public Icon getCachedIcon(File f) {
			return pathIconCache.get(f.getPath());
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see
		 * javax.swing.plaf.basic.BasicFileChooserUI$BasicFileView#getIcon(java
		 * .io.File)
		 */
		@Override
		public Icon getIcon(File f) {
			Icon icon = getCachedIcon(f);
			if (icon != null)
				return icon;

			icon = getDefaultIcon(f);
			// System.out.println("System : " + f.getAbsolutePath() + " --> "
			// + icon);
			if (icon == null) {
				icon = super.getIcon(f);
				if (icon == null) {
					icon = new ImageIcon(SubstanceCoreUtilities.getBlankImage(
							8, 8));
				}
				// System.out.println("Super : " + f.getAbsolutePath() + " --> "
				// + icon);
			}
			cacheIcon(f, icon);
			return icon;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see
		 * javax.swing.plaf.basic.BasicFileChooserUI$BasicFileView#cacheIcon
		 * (java.io.File, javax.swing.Icon)
		 */
		@Override
		public void cacheIcon(File f, Icon icon) {
			pathIconCache.put(f.getPath(), icon);
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see
		 * javax.swing.plaf.basic.BasicFileChooserUI$BasicFileView#clearIconCache
		 * ()
		 */
		@Override
		public void clearIconCache() {
			pathIconCache.clear();
		}

		/**
		 * Returns the default file icon.
		 * 
		 * @param f
		 *            File.
		 * @return File icon.
		 */
		public Icon getDefaultIcon(File f) {
			JFileChooser fileChooser = getFileChooser();
			Icon icon = fileChooser.getFileSystemView().getSystemIcon(f);

			if (SubstanceCoreUtilities.useThemedDefaultIcon()) {
				icon = SubstanceCoreUtilities.getThemedIcon(fileChooser, icon);
			}
			return icon;
		}
	}

	public static ComponentUI createUI(JComponent comp) {
		SubstanceCoreUtilities.testComponentCreationThreadingViolation(comp);
		return new SubstanceFileChooserUI((JFileChooser) comp);
	}

	/**
	 * Creates the UI delegate for the specified file chooser.
	 * 
	 * @param filechooser
	 *            File chooser.
	 */
	public SubstanceFileChooserUI(JFileChooser filechooser) {
		super(filechooser);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @seejavax.swing.plaf.basic.BasicFileChooserUI#getFileView(javax.swing.
	 * JFileChooser)
	 */
	@Override
	public FileView getFileView(JFileChooser fc) {
		return fileView;
	}
}
