org.openstreetmap.josm.actions

Class SaveActionBase

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.DiskAccessAction

org.openstreetmap.josm.actions.SaveActionBase

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, Destroyable

Direct Known Subclasses:

SaveAction, SaveAsAction

public abstract class SaveActionBase
extends DiskAccessAction

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.actions.JosmAction

JosmAction.LayerChangeAdapter, JosmAction.SelectionChangeAdapter

Field Summary

Fields

Modifier and Type	Field and Description
private File	file

Fields inherited from class org.openstreetmap.josm.actions.JosmAction

sc

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
SaveActionBase(String name, String iconName, String tooltip, Shortcut shortcut)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
(package private) static void	addToFileOpenHistory(File file)
private static File	checkFileAndConfirmOverWrite(AbstractFileChooser fc, String extension)
static boolean	confirmOverwrite(File file)
static File	createAndOpenSaveFileChooser(String title, ExtensionFileFilter filter) Creates a new "Save" dialog for a single ExtensionFileFilter and makes it visible. When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
static File	createAndOpenSaveFileChooser(String title, String extension) Creates a new "Save" dialog for a given file extension and makes it visible. When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
private static boolean	doInternalSave(Layer layer, File file)
boolean	doSave()
boolean	doSave(Layer layer)
static boolean	doSave(Layer layer, File file, boolean checkSaveConditions) Saves a layer to a given file.
protected abstract File	getFile(Layer layer)
protected void	updateEnabledState() Refreshes the enabled state

Methods inherited from class org.openstreetmap.josm.actions.DiskAccessAction

createAndOpenFileChooser, createAndOpenFileChooser, createAndOpenFileChooser, createAndOpenFileChooser, createAndOpenFileChooser

Methods inherited from class org.openstreetmap.josm.actions.JosmAction

destroy, getCurrentDataSet, getEditLayer, getShortcut, initEnabledState, installAdapters, setTooltip, updateEnabledState

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

file

private File file

Constructor Detail

SaveActionBase

public SaveActionBase(String name,
                      String iconName,
                      String tooltip,
                      Shortcut shortcut)

Method Detail

actionPerformed

public void actionPerformed(ActionEvent e)

doSave

public boolean doSave()

doSave

public boolean doSave(Layer layer)

doSave

public static boolean doSave(Layer layer,
                             File file,
                             boolean checkSaveConditions)

Saves a layer to a given file.

Parameters:

layer - The layer to save

file - The destination file

checkSaveConditions - if true, checks preconditions before saving. Set it to false to skip it if preconditions have already been checked (as this check can prompt UI dialog in EDT it may be best in some cases to do it earlier).

Returns:

true if the layer has been successfully saved, false otherwise

Since:

7204

doInternalSave

private static boolean doInternalSave(Layer layer,
                                      File file)

getFile

protected abstract File getFile(Layer layer)

updateEnabledState

protected void updateEnabledState()

Refreshes the enabled state

Overrides:

updateEnabledState in class JosmAction

See Also:

JosmAction.updateEnabledState(Collection), JosmAction.initEnabledState()

createAndOpenSaveFileChooser

public static File createAndOpenSaveFileChooser(String title,
                                                ExtensionFileFilter filter)

Creates a new "Save" dialog for a single ExtensionFileFilter and makes it visible.
When the user has chosen a file, checks the file extension, and confirms overwrite if needed.

Parameters:

title - The dialog title

filter - The dialog file filter

Returns:

The output File

Since:

5456

See Also:

DiskAccessAction.createAndOpenFileChooser(boolean, boolean, String, FileFilter, int, String)

createAndOpenSaveFileChooser

public static File createAndOpenSaveFileChooser(String title,
                                                String extension)

Creates a new "Save" dialog for a given file extension and makes it visible.
When the user has chosen a file, checks the file extension, and confirms overwrite if needed.

Parameters:

title - The dialog title

extension - The file extension

Returns:

The output File

See Also:

DiskAccessAction.createAndOpenFileChooser(boolean, boolean, String, String)

checkFileAndConfirmOverWrite

private static File checkFileAndConfirmOverWrite(AbstractFileChooser fc,
                                                 String extension)

confirmOverwrite

public static boolean confirmOverwrite(File file)

addToFileOpenHistory

static void addToFileOpenHistory(File file)