net.dermetfan.gdx.scenes.scene2d.ui.FileChooser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libgdx-utils Show documentation
support library for libGDX
There is a newer version: 0.13.4
/** Copyright 2014 Robin Stumm ([email protected], http://dermetfan.net)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License. */

package net.dermetfan.gdx.scenes.scene2d.ui;

import java.io.File;
import java.io.FileFilter;

import com.badlogic.gdx.files.FileHandle;
import com.badlogic.gdx.scenes.scene2d.ui.Table;
import com.badlogic.gdx.utils.Array;
import com.badlogic.gdx.utils.Pools;

/** base class for file choosers
 *  @see ListFileChooser
 *  @see TreeFileChooser
 *  @author dermetfan */
public abstract class FileChooser extends Table {

	/** called by a {@link ListFileChooser}
	 *  @author dermetfan */
	public interface Listener {

		/** called when a single file was chosen */
		public void choose(FileHandle file);

		/** Called when multiple files were chosen.
		 *  The Array given into the method will be {@link Pools#free(Object) returned} to the pool after the call, so make a copy if you need one.
		 *  @see #choose(FileHandle) */
		public void choose(Array files);

		/** Called when choosing one or more files was cancelled */
		public void cancel();

	}

	/** the {@link Listener} to notify */
	private Listener listener;

	/** determines if a file should be shown taking {@link #fileFilter} and {@link #showHidden} into account */
	protected final FileFilter handlingFileFilter = new FileFilter() {

		@Override
		public boolean accept(File file) {
			return (showHidden || !file.isHidden()) && (fileFilter == null || fileFilter.accept(file));
		}

	};

	/** a personal filter to determine if certain files should be shown */
	private FileFilter fileFilter;

	/** if hidden files should be shown */
	private boolean showHidden;

	/** if directories can be chosen */
	private boolean directoriesChoosable;

	/** whether a selection must be an existing file */
	private boolean newFilesChoosable;

	/** @param listener the {@link #listener} */
	public FileChooser(Listener listener) {
		this.listener = listener;
	}

	/** override this to build widgets in an implementation */
	protected abstract void build();

	/** @return the {@link #listener} */
	public Listener getListener() {
		return listener;
	}

	/** @param listener the {@link #listener} to set */
	public void setListener(Listener listener) {
		this.listener = listener;
	}

	/** @return the {@link #fileFilter} */
	public FileFilter getFileFilter() {
		return fileFilter;
	}

	/** @param fileFilter the {@link #fileFilter} to set */
	public void setFileFilter(FileFilter fileFilter) {
		this.fileFilter = fileFilter;
	}

	/** @return the {@link #handlingFileFilter} */
	public FileFilter getHandlingFileFilter() {
		return handlingFileFilter;
	}

	/** @return the {@link #showHidden} */
	public boolean isShowHidden() {
		return showHidden;
	}

	/** @param showHidden the {@link #showHidden} to set */
	public void setShowHidden(boolean showHidden) {
		this.showHidden = showHidden;
	}

	/** @return the {@link #directoriesChoosable} */
	public boolean isDirectoriesChoosable() {
		return directoriesChoosable;
	}

	/** @param directoriesChoosable the {@link #directoriesChoosable} to set */
	public void setDirectoriesChoosable(boolean directoriesChoosable) {
		this.directoriesChoosable = directoriesChoosable;
	}

	/** @return the {@link #newFilesChoosable} */
	public boolean isNewFilesChoosable() {
		return newFilesChoosable;
	}

	/** @param newFilesChoosable the {@link #newFilesChoosable} to set */
	public void setNewFilesChoosable(boolean newFilesChoosable) {
		this.newFilesChoosable = newFilesChoosable;
	}

}