info.bioinfweb.commons.swing

Class SwingSaver

java.lang.Object

info.bioinfweb.commons.changemonitor.ChangeMonitor

info.bioinfweb.commons.io.AbstractSaver

info.bioinfweb.commons.swing.SwingSaver

All Implemented Interfaces:

ChangeMonitorable, Savable

public abstract class SwingSaver
extends AbstractSaver
implements ChangeMonitorable, Savable

Implements the interface Savable with Swing-Dialogs.

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
SwingSaver()
SwingSaver(java.lang.String defaultName)

Method Summary

Modifier and Type	Method and Description
boolean	askToSave() Promts the user wheather to save changed data and calls save() if necessary.
boolean	askToSave(java.awt.Component parentComponent)
javax.swing.JFileChooser	getFileChooser() Returns the file dialog used by this instance in saveAs() and saveAs(Component).
boolean	saveAs() Opens a save dialog and asks the user where to save the file.
boolean	saveAs(java.awt.Component parentComponent) Opens a save dialog and asks the user where to save the file.

Methods inherited from class info.bioinfweb.commons.io.AbstractSaver

addFileExtension, endsWithDefaultExt, endsWithValidExt, getDefaultExtension, getDefaultName, getDefaultNameOrPath, getFile, getFileExtensions, hasFile, removeFileExtention, save, saveDataToFile, setDefaultExtension, setDefaultName, setFile

Methods inherited from class info.bioinfweb.commons.changemonitor.ChangeMonitor

hasChanged, registerChange, reset

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.bioinfweb.commons.io.Savable

addFileExtension, endsWithDefaultExt, endsWithValidExt, getDefaultExtension, getDefaultName, getDefaultNameOrPath, getFile, getFileExtensions, hasFile, removeFileExtention, save, setDefaultExtension, setDefaultName, setFile

Methods inherited from interface info.bioinfweb.commons.changemonitor.ChangeMonitorable

hasChanged, registerChange, reset

Constructor Detail

SwingSaver

public SwingSaver()

SwingSaver

public SwingSaver(java.lang.String defaultName)

Method Detail

askToSave

public boolean askToSave()

Description copied from interface: Savable

Promts the user wheather to save changed data and calls save() if necessary. If nothing has changed, there will be no prompt and the result is true.

Specified by:

askToSave in interface Savable

Specified by:

askToSave in class AbstractSaver

Returns:

true if the file can be closed or false if the user wants to cancel

askToSave

public boolean askToSave(java.awt.Component parentComponent)

saveAs

public boolean saveAs()

Opens a save dialog and asks the user where to save the file. Calling this method is equivalent to saveAs(null).

Note that this method must only be called inside the Swing thread because the used Swing methods are not thread save.

Specified by:

saveAs in interface Savable

Specified by:

saveAs in class AbstractSaver

Returns:

true if the file was successfully saved, false if the user canceled the operation

saveAs

public boolean saveAs(java.awt.Component parentComponent)

Opens a save dialog and asks the user where to save the file.

Note that this method must only be called inside the Swing thread because the used Swing methods are not thread save.

Parameters:

parentComponent - the parent component used to position the file dialog

Returns:

true if the file was successfully saved, false if the user canceled the operation

getFileChooser

public javax.swing.JFileChooser getFileChooser()

Returns the file dialog used by this instance in saveAs() and saveAs(Component).

Note that this component will be created when this method is called for the first time. The creation of that component is not thread save and therefore this method should only be called from the Swing thread.

Returns:

the file dialog instance used by this object