org.jfree.ui.action

Class AbstractFileSelectionAction

Implemented Interfaces:
Action, ActionDowngrade

public abstract class AbstractFileSelectionAction
extends AbstractActionDowngrade

A base class for all file operations. This implementation provides all methods to let the user select a file.
Author:
Thomas Morgner

Field Summary

Fields inherited from class org.jfree.ui.action.AbstractActionDowngrade

ACCELERATOR_KEY, MNEMONIC_KEY

Fields inherited from interface org.jfree.ui.action.ActionDowngrade

ACCELERATOR_KEY, MNEMONIC_KEY

Constructor Summary

AbstractFileSelectionAction(Component parent)
Creates a new FileSelectionAction with the given optional parent component as parent for the file chooser dialog.

Method Summary

protected JFileChooser
createFileChooser()
Creates the file chooser.
protected File
getCurrentDirectory()
Returns the working directory that should be used when initializing the FileChooser.
protected abstract String
getFileDescription()
Returns a descriptive text describing the file extension.
protected abstract String
getFileExtension()
Returns the file extension that should be used for the operation.
protected File
performSelectFile(File selectedFile, int dialogType, boolean appendExtension)
Selects a file to use as target for the operation.

Constructor Details

AbstractFileSelectionAction

public AbstractFileSelectionAction(Component parent)
Creates a new FileSelectionAction with the given optional parent component as parent for the file chooser dialog.
Parameters:
parent - the parent

Method Details

createFileChooser

protected JFileChooser createFileChooser()
Creates the file chooser.
Returns:
the initialized file chooser.

getCurrentDirectory

protected File getCurrentDirectory()
Returns the working directory that should be used when initializing the FileChooser.
Returns:
the working directory.

getFileDescription

protected abstract String getFileDescription()
Returns a descriptive text describing the file extension.
Returns:
the file description.

getFileExtension

protected abstract String getFileExtension()
Returns the file extension that should be used for the operation.
Returns:
the file extension.

performSelectFile

protected File performSelectFile(File selectedFile,
                                 int dialogType,
                                 boolean appendExtension)
Selects a file to use as target for the operation.
Parameters:
selectedFile - the selected file.
dialogType - the dialog type.
appendExtension - true, if the file extension should be added if necessary, false if the unmodified filename should be used.
Returns:
the selected and approved file or null, if the user canceled the operation