org.orbisgis.sif.components

Class AbstractOpenPanel

java.lang.Object

org.orbisgis.sif.components.AbstractOpenPanel

All Implemented Interfaces:

UIPanel, UIPersistence

Direct Known Subclasses:

OpenFilePanel, OpenFolderPanel

public abstract class AbstractOpenPanel
extends Object
implements UIPanel, UIPersistence

Contains utility methods by both OpenFilePanel and OpenFolderPanel.

Author:

Alexis Guéganno

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractOpenPanel.FormatFilter

Constructor Summary

Constructors

Constructor and Description
AbstractOpenPanel(String id, String title) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilter(String[] extensions, String description)
void	addFilter(String extension, String description)
Component	getComponent() Gets the swing component to show in the dialog
File	getCurrentDirectory() Get the directory browsed by the user
int	getCurrentFilterId() Return the identifier of the current filter
JFileChooser	getFileChooser() This method returns the FileChooser attached to this.
File	getSelectedFile()
File[]	getSelectedFiles()
String	getTitle() Gets the title to show in the dialog
void	loadState() Recover the dialog state on the last save state, using the dialog identifier.
void	saveState() Save the current state of the dialog.
void	setAcceptAllFileFilterUsed(boolean enableAllFiles) Determines whether the AcceptAll FileFilter is used as an available choice in the choosable filter list.
void	setCurrentDirectory(File dir) Set the directory shown to the user
boolean	setCurrentFilter(int filterIdentifier) Set the selected file filter
void	setSelectedFile(File file) Set the selected file in the directory
void	setSingleSelection(boolean singleSelection) Set the file dialog to allow single selection.
abstract boolean	showFoldersOnly() To be set by inheriting classes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orbisgis.sif.UIPanel

getIconURL, validateInput

Constructor Detail

AbstractOpenPanel

public AbstractOpenPanel(String id,
                 String title)

Constructor

Parameters:

id - Identifier of this dialog, used to recover the old state of this dialog

title - Localised title of this dialog

Method Detail

loadState

public void loadState()

Recover the dialog state on the last save state, using the dialog identifier. The following properties may be overwritten - Current directory - Current filter

Specified by:

loadState in interface UIPersistence

saveState

public void saveState()

Save the current state of the dialog.

Specified by:

saveState in interface UIPersistence

addFilter

public void addFilter(String extension,
             String description)

setAcceptAllFileFilterUsed

public void setAcceptAllFileFilterUsed(boolean enableAllFiles)

Determines whether the AcceptAll FileFilter is used as an available choice in the choosable filter list. If false, the AcceptAll file filter is removed from the list of available file filters. If true, the AcceptAll file filter will become the the actively used file filter.

Parameters:

enableAllFiles -

addFilter

public void addFilter(String[] extensions,
             String description)

getComponent

public Component getComponent()

Description copied from interface: UIPanel

Gets the swing component to show in the dialog

Specified by:

getComponent in interface UIPanel

Returns:

getFileChooser

public JFileChooser getFileChooser()

This method returns the FileChooser attached to this. It creates a new one if the FileChooser has not been instanciated before.

Returns:

setSingleSelection

public void setSingleSelection(boolean singleSelection)

Set the file dialog to allow single selection.

Parameters:

singleSelection - True for single, false for multiple

showFoldersOnly

public abstract boolean showFoldersOnly()

To be set by inheriting classes. True if you want to show the folders only.

Returns:

getTitle

public String getTitle()

Description copied from interface: UIPanel

Gets the title to show in the dialog

Specified by:

getTitle in interface UIPanel

Returns:

getSelectedFile

public File getSelectedFile()

getSelectedFiles

public File[] getSelectedFiles()

setSelectedFile

public void setSelectedFile(File file)

Set the selected file in the directory

Parameters:

file -

setCurrentDirectory

public void setCurrentDirectory(File dir)

Set the directory shown to the user

Parameters:

dir -

getCurrentDirectory

public File getCurrentDirectory()

Get the directory browsed by the user

getCurrentFilterId

public int getCurrentFilterId()

Return the identifier of the current filter

Returns:

The filter identifier, given by FileFilter.hashCode()

See Also:

setCurrentFilter

setCurrentFilter

public boolean setCurrentFilter(int filterIdentifier)

Set the selected file filter

Returns:

True if the filter has been found and set

See Also:

getCurrentFilterId