Module org.jhotdraw8.application

Package org.jhotdraw8.application.action.file

Class AbstractSaveFileAction

java.lang.Object

org.jhotdraw8.application.AbstractDisableable

org.jhotdraw8.application.action.AbstractAction

org.jhotdraw8.application.action.AbstractApplicationAction

org.jhotdraw8.application.action.AbstractActivityAction<FileBasedActivity>

org.jhotdraw8.application.action.file.AbstractSaveFileAction

All Implemented Interfaces:

EventListener, javafx.event.EventHandler<javafx.event.ActionEvent>, Action, PropertyBean, Disableable

Direct Known Subclasses:

ExportFileAction, SaveFileAction

public abstract class AbstractSaveFileAction
extends AbstractActivityAction<FileBasedActivity>

Saves the changes in the active view. If the active view has not an URI, an URIChooser is presented.

Author:

Werner Randelshofer

Property Summary

Properties inherited from class org.jhotdraw8.application.action.AbstractAction

selected

Properties inherited from class org.jhotdraw8.application.AbstractDisableable

disabled

Properties inherited from interface org.jhotdraw8.fxbase.control.Disableable

disabled

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull org.jhotdraw8.fxcollection.typesafekey.Key<Supplier<URIChooser>>	SAVE_CHOOSER_FACTORY_KEY
static final @NonNull org.jhotdraw8.fxcollection.typesafekey.Key<URIChooser>	SAVE_CHOOSER_KEY

Fields inherited from class org.jhotdraw8.application.action.AbstractApplicationAction

app

Fields inherited from class org.jhotdraw8.application.action.AbstractAction

properties

Fields inherited from class org.jhotdraw8.application.AbstractDisableable

disabled, disablers

Fields inherited from interface org.jhotdraw8.application.action.Action

ACCELERATOR_KEY, ID_KEY, LABEL, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, SELECTED_PROPERTY, SHORT_DESCRIPTION, SMALL_ICON

Fields inherited from interface org.jhotdraw8.fxbase.control.Disableable

DISABLED_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractSaveFileAction(@NonNull FileBasedActivity activity, @NonNull String id, boolean saveAs, @NonNull Resources resources)	Creates a new instance.
AbstractSaveFileAction(@NonNull FileBasedActivity activity, String id, boolean saveAs)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected @Nullable javafx.scene.control.Dialog<SequencedMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object>>	createOptionsDialog(javafx.scene.input.DataFormat format)
protected @NonNull URIChooser	getChooser(FileBasedActivity view)
protected void	onActionPerformed(@NonNull javafx.event.ActionEvent evt, @NonNull FileBasedActivity activity)	This method is invoked when the action is not disabled and the event is not consumed.
protected abstract void	onSaveSucceeded(FileBasedActivity v, URI uri, javafx.scene.input.DataFormat format)
protected void	saveFileChooseOptions(@NonNull FileBasedActivity v, @NonNull URI uri, javafx.scene.input.DataFormat format, WorkState<Void> workState)
protected void	saveFileChooseUri(@NonNull FileBasedActivity v, WorkState<Void> workState)
protected void	saveFileToUri(@NonNull FileBasedActivity view, @NonNull URI uri, javafx.scene.input.DataFormat format, @NonNull Map<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object> options, WorkState<Void> workState)

Methods inherited from class org.jhotdraw8.application.action.AbstractActivityAction

getActivity, onActionPerformed

Methods inherited from class org.jhotdraw8.application.action.AbstractApplicationAction

createAlert, createErrorMessage, getApplication, onActionPerformed

Methods inherited from class org.jhotdraw8.application.action.AbstractAction

getProperties, handle, selectedProperty

Methods inherited from class org.jhotdraw8.application.AbstractDisableable

disabledProperty, disablers

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jhotdraw8.application.action.Action

getId, getLabel, isSelected, setSelected

Methods inherited from interface org.jhotdraw8.fxbase.control.Disableable

addDisabler, disabledProperty, disablers, isDisabled, removeDisabler

Methods inherited from interface org.jhotdraw8.fxbase.beans.PropertyBean

get, getNonNull, getProperty, put, remove, set, setNonNull, valueAt

Field Details

SAVE_CHOOSER_KEY

public static final @NonNull org.jhotdraw8.fxcollection.typesafekey.Key<URIChooser> SAVE_CHOOSER_KEY

SAVE_CHOOSER_FACTORY_KEY

public static final @NonNull org.jhotdraw8.fxcollection.typesafekey.Key<Supplier<URIChooser>> SAVE_CHOOSER_FACTORY_KEY

Constructor Details

AbstractSaveFileAction

public AbstractSaveFileAction(@NonNull FileBasedActivity activity,
 String id,
 boolean saveAs)

Creates a new instance.

Parameters:

activity - the view

id - the id

saveAs - whether to force a file dialog

AbstractSaveFileAction

public AbstractSaveFileAction(@NonNull FileBasedActivity activity,
 @NonNull String id,
 boolean saveAs,
 @NonNull Resources resources)

Creates a new instance.

Parameters:

activity - the view

id - the id

saveAs - whether to force a file dialog

resources - the resources are used for setting labels and icons for the action

Method Details

getChooser

protected @NonNull URIChooser getChooser(FileBasedActivity view)

onActionPerformed

protected void onActionPerformed(@NonNull javafx.event.ActionEvent evt,
 @NonNull FileBasedActivity activity)

Description copied from class: AbstractActivityAction

This method is invoked when the action is not disabled and the event is not consumed.

Specified by:

onActionPerformed in class AbstractActivityAction<FileBasedActivity>

Parameters:

evt - the action event

activity - the activity

saveFileChooseUri

protected void saveFileChooseUri(@NonNull FileBasedActivity v,
 WorkState<Void> workState)

saveFileChooseOptions

protected void saveFileChooseOptions(@NonNull FileBasedActivity v,
 @NonNull URI uri,
 javafx.scene.input.DataFormat format,
 WorkState<Void> workState)

saveFileToUri

protected void saveFileToUri(@NonNull FileBasedActivity view,
 @NonNull URI uri,
 javafx.scene.input.DataFormat format,
 @NonNull Map<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object> options,
 WorkState<Void> workState)

createOptionsDialog

protected @Nullable javafx.scene.control.Dialog<SequencedMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object>> createOptionsDialog(javafx.scene.input.DataFormat format)

onSaveSucceeded

protected abstract void onSaveSucceeded(FileBasedActivity v,
 URI uri,
 javafx.scene.input.DataFormat format)