xdev.ui.XdevFileChooserFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xapi Show documentation
XDEV Application Framework
There is a newer version: 6.0.2
package xdev.ui;

/*-
 * #%L
 * XDEV Application Framework
 * %%
 * Copyright (C) 2003 - 2020 XDEV Software
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.File;
import java.util.Hashtable;
import java.util.Map;

import javax.swing.filechooser.FileFilter;


/**
 * Factory class for {@link XdevFileChooser}.
 * 
 * Example:

 * 

 * 
 * XdevFileChooser chooser = XdevFileChooserFactory.getFileChooser(

 * "Media", // key used for caching and persistance 

 * new XdevFileFilter("Audio Files","mp3","flac","ogg"),

 * new XdevFileFilter("Video Files","mp4","mpg","avi"));

 * XdevFile file = chooser.showOpenDialog();
 * 
 * 
 * 
 * 
 * @see XdevFileChooser
 * @see XdevFileFilter
 * 
 * @author XDEV Software Corp.
 * 
 */

public final class XdevFileChooserFactory
{
	private XdevFileChooserFactory()
	{
	}
	
	private static Map	cache;
	private static XdevFileChooser					fileChooser;
	
	
	/**
	 * Shortcut for getFileChooser(key,false,false,filters).
	 * 
	 * @see #getFileChooser(String, boolean, boolean, FileFilter...)
	 */
	public static XdevFileChooser getFileChooser(String key, FileFilter... filters)
	{
		return getFileChooser(key,false,false,filters);
	}
	
	
	/**
	 * Shortcut for getFileChooser(key,false,acceptAllFileFilter,filters).
	 * 
	 * @see #getFileChooser(String, boolean, boolean, FileFilter...)
	 */
	
	public static XdevFileChooser getFileChooser(String key, boolean acceptAllFileFilter,
			FileFilter... filters)
	{
		return getFileChooser(key,false,acceptAllFileFilter,filters);
	}
	
	
	/**
	 * Returns a {@link XdevFileChooser} associated with key.
	 * 
	 * If the XdevFileChooser should check for the right extension when saving a
	 * file use a {@link XdevFileFilter}.
	 * 
	 * 
	 * @param key
	 *            the id of the file chooser, e.g. "XML files" or "images"
	 * @param multiSelectionEnabled
	 *            true if multiple files may be selected
	 * @param acceptAllFileFilter
	 *            true if the all file filter should be used
	 * @param filters
	 *            the filters for the filechooser
	 * @return the file chooser associated with key
	 */
	
	public static XdevFileChooser getFileChooser(String key, boolean multiSelectionEnabled,
			boolean acceptAllFileFilter, FileFilter... filters)
	{
		if(cache == null)
		{
			cache = new Hashtable();
			fileChooser = new XdevFileChooser();
		}
		
		FileChooserState state = cache.get(key);
		if(state != null)
		{
			fileChooser.setCurrentDirectory(state.currentDirectory);
		}
		else
		{
			state = new FileChooserState();
			cache.put(key,state);
		}
		
		fileChooser.addWindowListener(state);
		fileChooser.setMultiSelectionEnabled(multiSelectionEnabled);
		fileChooser.clearChooseableFileFilters();
		fileChooser.setAcceptAllFileFilterUsed(acceptAllFileFilter);
		for(FileFilter filter : filters)
		{
			fileChooser.addChoosableFileFilter(filter);
		}
		
		return fileChooser;
	}
	
	
	
	private static class FileChooserState extends WindowAdapter
	{
		File	currentDirectory;
		
		
		public void windowClosed(WindowEvent e)
		{
			currentDirectory = fileChooser.getCurrentDirectory();
			fileChooser.removeWindowListener(this);
		}
	}
}