Module org.jhotdraw8.application

Package org.jhotdraw8.application.action.file

Class AbstractOpenFileAction

java.lang.Object

org.jhotdraw8.application.AbstractDisableable

org.jhotdraw8.application.action.AbstractAction

org.jhotdraw8.application.action.AbstractApplicationAction

org.jhotdraw8.application.action.file.AbstractOpenFileAction

All Implemented Interfaces:

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

Direct Known Subclasses:

OpenFileAction

public abstract class AbstractOpenFileAction
extends AbstractApplicationAction

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>>	OPEN_CHOOSER_FACTORY_KEY
static final @NonNull org.jhotdraw8.fxcollection.typesafekey.Key<URIChooser>	OPEN_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
AbstractOpenFileAction(@NonNull FileBasedApplication app)

Method Summary

Modifier and Type	Method	Description
void	doIt(@NonNull FileBasedActivity view, boolean disposeView, WorkState<Void> workState)
protected @Nullable URIChooser	getChooser(FileBasedActivity view)
protected abstract @NonNull Map<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object>	getReadOptions()	Gets options for FileBasedActivity.read(java.net.URI, javafx.scene.input.DataFormat, org.jhotdraw8.icollection.immutable.ImmutableMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>, java.lang.Object>, boolean, org.jhotdraw8.fxbase.concurrent.WorkState<java.lang.Void>).
protected abstract boolean	isReuseEmptyViews()
protected void	onActionPerformed(@NonNull javafx.event.ActionEvent evt, @NonNull Application app)	This method is invoked when the action is not disabled and the event is not consumed.
protected void	openActivityFromURI(@NonNull FileBasedActivity v, @NonNull URI uri, @NonNull URIChooser chooser, WorkState<Void> workState)

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

OPEN_CHOOSER_KEY

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

OPEN_CHOOSER_FACTORY_KEY

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

Constructor Details

AbstractOpenFileAction

public AbstractOpenFileAction(@NonNull FileBasedApplication app)

Method Details

getChooser

protected @Nullable URIChooser getChooser(FileBasedActivity view)

isReuseEmptyViews

protected abstract boolean isReuseEmptyViews()

onActionPerformed

protected void onActionPerformed(@NonNull javafx.event.ActionEvent evt,
 @NonNull Application app)

Description copied from class: AbstractApplicationAction

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

Specified by:

onActionPerformed in class AbstractApplicationAction

Parameters:

evt - the action event

app - the applicatoin

doIt

public void doIt(@NonNull FileBasedActivity view,
 boolean disposeView,
 WorkState<Void> workState)

openActivityFromURI

protected void openActivityFromURI(@NonNull FileBasedActivity v,
 @NonNull URI uri,
 @NonNull URIChooser chooser,
 WorkState<Void> workState)

getReadOptions

protected abstract @NonNull Map<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object> getReadOptions()

Gets options for FileBasedActivity.read(java.net.URI, javafx.scene.input.DataFormat, org.jhotdraw8.icollection.immutable.ImmutableMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>, java.lang.Object>, boolean, org.jhotdraw8.fxbase.concurrent.WorkState<java.lang.Void>). The options can be null, a constant, or from user input through a dialog window.

The value null means that the user has aborted the dialog window. In this case, the action will not open a file!

Returns:

options or null if the user has aborted the dialog window