Module org.jhotdraw8.application

Package org.jhotdraw8.application.action

Class AbstractSaveUnsavedChangesAction

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.AbstractSaveUnsavedChangesAction

All Implemented Interfaces:

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

Direct Known Subclasses:

ClearFileAction, CloseFileAction

public abstract class AbstractSaveUnsavedChangesAction
extends AbstractActivityAction<FileBasedActivity>

This abstract class can be extended to implement an Action that asks to write unsaved changes of a FileBasedActivity before a destructive action is performed.

If the view has no unsaved changes, method doIt is invoked immediately. If unsaved changes are present, a dialog is shown asking whether the user wants to discard the changes, cancel or write the changes before doing it. If the user chooses to discard the changes, doIt is invoked immediately. If the user chooses to cancel, the action is aborted. If the user chooses to write the changes, the view is saved, and doIt is only invoked after the view was successfully saved.

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 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
AbstractSaveUnsavedChangesAction(@NonNull FileBasedActivity activity)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected abstract CompletionStage<Void>	doIt(FileBasedActivity p)
protected @Nullable URIChooser	getChooser(FileBasedActivity view)
protected @Nullable javafx.scene.Node	getFocusOwner(@NonNull javafx.scene.Node node)
void	onActionOnViewPerformed(@NonNull FileBasedActivity v)
protected final 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 void	saveView(@NonNull FileBasedActivity v, WorkState<Void> workState)
protected void	saveViewToURI(@NonNull FileBasedActivity v, @NonNull URI uri, @Nullable URIChooser chooser, javafx.scene.input.DataFormat dataFormat, 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

Constructor Details

AbstractSaveUnsavedChangesAction

public AbstractSaveUnsavedChangesAction(@NonNull FileBasedActivity activity)

Creates a new instance.

Parameters:

activity - the view

Method Details

onActionPerformed

protected final 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

getChooser

protected @Nullable URIChooser getChooser(FileBasedActivity view)

onActionOnViewPerformed

public void onActionOnViewPerformed(@NonNull FileBasedActivity v)

getFocusOwner

protected @Nullable javafx.scene.Node getFocusOwner(@NonNull javafx.scene.Node node)

saveView

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

saveViewToURI

protected void saveViewToURI(@NonNull FileBasedActivity v,
 @NonNull URI uri,
 @Nullable URIChooser chooser,
 javafx.scene.input.DataFormat dataFormat,
 WorkState<Void> workState)

doIt

protected abstract CompletionStage<Void> doIt(FileBasedActivity p)