Module org.jhotdraw8.application

Package org.jhotdraw8.application

Interface Application

All Superinterfaces:

Disableable, PropertyBean

All Known Subinterfaces:

FileBasedApplication

All Known Implementing Classes:

AbstractApplication, AbstractFileBasedApplication

public interface Application
extends Disableable, PropertyBean

An Application handles the life-cycle of Activity objects and provides windows to present them on screen.

Author:

Werner Randelshofer

Property Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.ReadOnlyMapProperty<String,Action>	actions	Contains all Action objects that are managed by this Application.
javafx.beans.property.ReadOnlyObjectProperty<Activity>	activeActivity	Provides the currently active activities.
@NonNull javafx.beans.property.ReadOnlySetProperty<Activity>	activities	Contains all Activity objects that are managed by this Application.
@NonNull javafx.beans.property.ObjectProperty<Supplier<Activity>>	activityFactory
@NonNull javafx.beans.property.IntegerProperty	maxNumberOfRecentUris	The maximal number of recent URIs.
@NonNull javafx.beans.property.ObjectProperty<Supplier<javafx.scene.control.MenuBar>>	menuBarFactory
@NonNull NonNullObjectProperty<Preferences>	preferences
javafx.beans.property.ReadOnlyMapProperty<URI,javafx.scene.input.DataFormat>	recentUris	The set of recent URIs.
@NonNull NonNullObjectProperty<Resources>	resources
@NonNull javafx.beans.property.ReadOnlyListProperty<String>	stylesheets

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

disabled

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIONS_PROPERTY
static final String	ACTIVITIES_PROPERTY
static final String	ACTIVITY_FACTORY_PROPERTY
static final org.jhotdraw8.fxcollection.typesafekey.Key<String>	COPYRIGHT_KEY
static final org.jhotdraw8.fxcollection.typesafekey.Key<String>	LICENSE_KEY
static final String	MAX_NUMBER_OF_RECENT_URIS_PROPERTY
static final String	MENU_BAR_FACTORY_PROPERTY
static final org.jhotdraw8.fxcollection.typesafekey.Key<String>	NAME_KEY
static final String	PREFERENCES_PROPERTY
static final String	RECENT_URIS_PROPERTY
static final String	RESOURCE_BUNDLE_PROPERTY
static final String	STYLESHEETS_PROPERTY
static final org.jhotdraw8.fxcollection.typesafekey.Key<String>	VERSION_KEY

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

DISABLED_PROPERTY

Method Summary

Modifier and Type	Method	Description
@NonNull javafx.beans.property.ReadOnlyMapProperty<String,Action>	actionsProperty()	Contains all Action objects that are managed by this Application.
javafx.beans.property.ReadOnlyObjectProperty<Activity>	activeActivityProperty()	Provides the currently active activities.
@NonNull javafx.beans.property.ReadOnlySetProperty<Activity>	activitiesProperty()	Contains all Activity objects that are managed by this Application.
@NonNull javafx.beans.property.ObjectProperty<Supplier<Activity>>	activityFactoryProperty()
default CompletionStage<Activity>	createActivity()	Creates a new activity, initializes it, then invokes the callback.
void	exit()	Exits the application.
default @NonNull javafx.collections.ObservableMap<String,Action>	getActions()	Gets the value of the actions property.
default @Nullable Activity	getActiveActivity()	Gets the value of the activeActivity property.
default @NonNull javafx.collections.ObservableSet<Activity>	getActivities()	Gets the value of the activities property.
default Supplier<Activity>	getActivityFactory()	Gets the value of the activityFactory property.
Executor	getExecutor()
default int	getMaxNumberOfRecentUris()	Gets the value of the maxNumberOfRecentUris property.
default @Nullable Supplier<javafx.scene.control.MenuBar>	getMenuBarFactory()	Gets the value of the menuBarFactory property.
default @Nullable javafx.scene.Node	getNode()	Returns the application node.
default @NonNull Preferences	getPreferences()	Gets the value of the preferences property.
default @NonNull javafx.collections.ObservableMap<URI,javafx.scene.input.DataFormat>	getRecentUris()	Gets the value of the recentUris property.
default @NonNull Resources	getResources()	Gets the value of the resources property.
default @NonNull javafx.collections.ObservableList<String>	getStylesheets()	Gets the value of the stylesheets property.
@NonNull javafx.beans.property.IntegerProperty	maxNumberOfRecentUrisProperty()	The maximal number of recent URIs.
@NonNull javafx.beans.property.ObjectProperty<Supplier<javafx.scene.control.MenuBar>>	menuBarFactoryProperty()
@NonNull NonNullObjectProperty<Preferences>	preferencesProperty()
javafx.beans.property.ReadOnlyMapProperty<URI,javafx.scene.input.DataFormat>	recentUrisProperty()	The set of recent URIs.
@NonNull NonNullObjectProperty<Resources>	resourcesProperty()
default void	setActivityFactory(Supplier<Activity> newValue)	Sets the value of the activityFactory property.
default void	setMaxNumberOfRecentUris(int newValue)	Sets the value of the maxNumberOfRecentUris property.
default void	setMenuBarFactory(@Nullable Supplier<javafx.scene.control.MenuBar> newValue)	Sets the value of the menuBarFactory property.
default void	setPreferences(@NonNull Preferences preferences)	Sets the value of the preferences property.
default void	setResources(@NonNull Resources newValue)	Sets the value of the resources property.
@NonNull javafx.beans.property.ReadOnlyListProperty<String>	stylesheetsProperty()

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, getProperties, getProperty, put, remove, set, setNonNull, valueAt

Property Details

activities

@NonNull javafx.beans.property.ReadOnlySetProperty<Activity> activitiesProperty

Contains all Activity objects that are managed by this Application.

See Also:

• getActivities()
• activitiesProperty()

preferences

@NonNull NonNullObjectProperty<Preferences> preferencesProperty

See Also:

• getPreferences()
• setPreferences(Preferences)
• preferencesProperty()

actions

@NonNull javafx.beans.property.ReadOnlyMapProperty<String,Action> actionsProperty

Contains all Action objects that are managed by this Application.

See Also:

• getActions()
• actionsProperty()

recentUris

javafx.beans.property.ReadOnlyMapProperty<URI,javafx.scene.input.DataFormat> recentUrisProperty

The set of recent URIs. The set must be ordered by most recently used first. Only the first items as specified in maxNumberOfRecentUrisProperty() of the set are used and persisted in user preferences.

See Also:

• getRecentUris()
• recentUrisProperty()

maxNumberOfRecentUris

@NonNull javafx.beans.property.IntegerProperty maxNumberOfRecentUrisProperty

The maximal number of recent URIs. Specifies how many items of recentUrisProperty() are used and persisted in user preferences. This number is also persisted in user preferences.

See Also:

• getMaxNumberOfRecentUris()
• setMaxNumberOfRecentUris(int)
• maxNumberOfRecentUrisProperty()

activeActivity

javafx.beans.property.ReadOnlyObjectProperty<Activity> activeActivityProperty

Provides the currently active activities. This is the last activities which was focus owner. Returns null, if the application has no views.

See Also:

• getActiveActivity()
• activeActivityProperty()

activityFactory

@NonNull javafx.beans.property.ObjectProperty<Supplier<Activity>> activityFactoryProperty

See Also:

• getActivityFactory()
• setActivityFactory(Supplier)
• activityFactoryProperty()

menuBarFactory

@NonNull javafx.beans.property.ObjectProperty<Supplier<javafx.scene.control.MenuBar>> menuBarFactoryProperty

See Also:

• getMenuBarFactory()
• setMenuBarFactory(Supplier)
• menuBarFactoryProperty()

resources

@NonNull NonNullObjectProperty<Resources> resourcesProperty

See Also:

• getResources()
• setResources(Resources)
• resourcesProperty()

stylesheets

@NonNull javafx.beans.property.ReadOnlyListProperty<String> stylesheetsProperty

See Also:

• getStylesheets()
• stylesheetsProperty()

Field Details

ACTIONS_PROPERTY

static final String ACTIONS_PROPERTY

See Also:

• Constant Field Values

ACTIVITIES_PROPERTY

static final String ACTIVITIES_PROPERTY

See Also:

• Constant Field Values

ACTIVITY_FACTORY_PROPERTY

static final String ACTIVITY_FACTORY_PROPERTY

See Also:

• Constant Field Values

RESOURCE_BUNDLE_PROPERTY

static final String RESOURCE_BUNDLE_PROPERTY

See Also:

• Constant Field Values

MENU_BAR_FACTORY_PROPERTY

static final String MENU_BAR_FACTORY_PROPERTY

See Also:

• Constant Field Values

RECENT_URIS_PROPERTY

static final String RECENT_URIS_PROPERTY

See Also:

• Constant Field Values

PREFERENCES_PROPERTY

static final String PREFERENCES_PROPERTY

See Also:

• Constant Field Values

MAX_NUMBER_OF_RECENT_URIS_PROPERTY

static final String MAX_NUMBER_OF_RECENT_URIS_PROPERTY

See Also:

• Constant Field Values

STYLESHEETS_PROPERTY

static final String STYLESHEETS_PROPERTY

See Also:

• Constant Field Values

NAME_KEY

static final org.jhotdraw8.fxcollection.typesafekey.Key<String> NAME_KEY

VERSION_KEY

static final org.jhotdraw8.fxcollection.typesafekey.Key<String> VERSION_KEY

COPYRIGHT_KEY

static final org.jhotdraw8.fxcollection.typesafekey.Key<String> COPYRIGHT_KEY

LICENSE_KEY

static final org.jhotdraw8.fxcollection.typesafekey.Key<String> LICENSE_KEY

Method Details

activitiesProperty

@NonNull javafx.beans.property.ReadOnlySetProperty<Activity> activitiesProperty()

Contains all Activity objects that are managed by this Application.

Returns:

the activities

See Also:

• getActivities()

getExecutor

Executor getExecutor()

preferencesProperty

@NonNull NonNullObjectProperty<Preferences> preferencesProperty()

Returns:

the preferences property

See Also:

• getPreferences()
• setPreferences(Preferences)

actionsProperty

@NonNull javafx.beans.property.ReadOnlyMapProperty<String,Action> actionsProperty()

Contains all Action objects that are managed by this Application.

Returns:

the activities

See Also:

• getActions()

getActions

default @NonNull javafx.collections.ObservableMap<String,Action> getActions()

Gets the value of the actions property.

Property description:

Contains all Action objects that are managed by this Application.

Returns:

the value of the actions property

See Also:

• actionsProperty()

getPreferences

default @NonNull Preferences getPreferences()

Gets the value of the preferences property.

Property description:

Returns:

the value of the preferences property

See Also:

• setPreferences(Preferences)
• preferencesProperty()

setPreferences

default void setPreferences(@NonNull Preferences preferences)

Sets the value of the preferences property.

Property description:

Parameters:

preferences - the value for the preferences property

See Also:

• getPreferences()
• preferencesProperty()

recentUrisProperty

javafx.beans.property.ReadOnlyMapProperty<URI,javafx.scene.input.DataFormat> recentUrisProperty()

The set of recent URIs. The set must be ordered by most recently used first. Only the first items as specified in maxNumberOfRecentUrisProperty() of the set are used and persisted in user preferences.

Returns:

the recent Uris

See Also:

• getRecentUris()

getRecentUris

default @NonNull javafx.collections.ObservableMap<URI,javafx.scene.input.DataFormat> getRecentUris()

Gets the value of the recentUris property.

Property description:

The set of recent URIs. The set must be ordered by most recently used first. Only the first items as specified in maxNumberOfRecentUrisProperty() of the set are used and persisted in user preferences.

Returns:

the value of the recentUris property

See Also:

• recentUrisProperty()

maxNumberOfRecentUrisProperty

@NonNull javafx.beans.property.IntegerProperty maxNumberOfRecentUrisProperty()

The maximal number of recent URIs. Specifies how many items of recentUrisProperty() are used and persisted in user preferences. This number is also persisted in user preferences.

Returns:

the number of recent Uris

See Also:

• getMaxNumberOfRecentUris()
• setMaxNumberOfRecentUris(int)

getActivities

default @NonNull javafx.collections.ObservableSet<Activity> getActivities()

Gets the value of the activities property.

Property description:

Contains all Activity objects that are managed by this Application.

Returns:

the value of the activities property

See Also:

• activitiesProperty()

activeActivityProperty

javafx.beans.property.ReadOnlyObjectProperty<Activity> activeActivityProperty()

Provides the currently active activities. This is the last activities which was focus owner. Returns null, if the application has no views.

Returns:

The active activities.

See Also:

• getActiveActivity()

getActiveActivity

default @Nullable Activity getActiveActivity()

Gets the value of the activeActivity property.

Property description:

Provides the currently active activities. This is the last activities which was focus owner. Returns null, if the application has no views.

Returns:

the value of the activeActivity property

See Also:

• activeActivityProperty()

exit

void exit()

Exits the application.

getNode

default @Nullable javafx.scene.Node getNode()

Returns the application node.

Returns:

the node

createActivity

default CompletionStage<Activity> createActivity()

Creates a new activity, initializes it, then invokes the callback.

Returns:

A callback.

getMaxNumberOfRecentUris

default int getMaxNumberOfRecentUris()

Gets the value of the maxNumberOfRecentUris property.

Property description:

The maximal number of recent URIs. Specifies how many items of recentUrisProperty() are used and persisted in user preferences. This number is also persisted in user preferences.

Returns:

the value of the maxNumberOfRecentUris property

See Also:

• setMaxNumberOfRecentUris(int)
• maxNumberOfRecentUrisProperty()

setMaxNumberOfRecentUris

default void setMaxNumberOfRecentUris(int newValue)

Sets the value of the maxNumberOfRecentUris property.

Property description:

The maximal number of recent URIs. Specifies how many items of recentUrisProperty() are used and persisted in user preferences. This number is also persisted in user preferences.

Parameters:

newValue - the value for the maxNumberOfRecentUris property

See Also:

• getMaxNumberOfRecentUris()
• maxNumberOfRecentUrisProperty()

activityFactoryProperty

@NonNull javafx.beans.property.ObjectProperty<Supplier<Activity>> activityFactoryProperty()

Returns:

the activityFactory property

See Also:

• getActivityFactory()
• setActivityFactory(Supplier)

getActivityFactory

default Supplier<Activity> getActivityFactory()

Gets the value of the activityFactory property.

Property description:

Returns:

the value of the activityFactory property

See Also:

• setActivityFactory(Supplier)
• activityFactoryProperty()

setActivityFactory

default void setActivityFactory(Supplier<Activity> newValue)

Sets the value of the activityFactory property.

Property description:

Parameters:

newValue - the value for the activityFactory property

See Also:

• getActivityFactory()
• activityFactoryProperty()

menuBarFactoryProperty

@NonNull javafx.beans.property.ObjectProperty<Supplier<javafx.scene.control.MenuBar>> menuBarFactoryProperty()

Returns:

the menuBarFactory property

See Also:

• getMenuBarFactory()
• setMenuBarFactory(Supplier)

resourcesProperty

@NonNull NonNullObjectProperty<Resources> resourcesProperty()

Returns:

the resources property

See Also:

• getResources()
• setResources(Resources)

getMenuBarFactory

default @Nullable Supplier<javafx.scene.control.MenuBar> getMenuBarFactory()

Gets the value of the menuBarFactory property.

Property description:

Returns:

the value of the menuBarFactory property

See Also:

• setMenuBarFactory(Supplier)
• menuBarFactoryProperty()

stylesheetsProperty

@NonNull javafx.beans.property.ReadOnlyListProperty<String> stylesheetsProperty()

Returns:

the stylesheets property

See Also:

• getStylesheets()

getStylesheets

default @NonNull javafx.collections.ObservableList<String> getStylesheets()

Gets the value of the stylesheets property.

Property description:

Returns:

the value of the stylesheets property

See Also:

• stylesheetsProperty()

setMenuBarFactory

default void setMenuBarFactory(@Nullable Supplier<javafx.scene.control.MenuBar> newValue)

Sets the value of the menuBarFactory property.

Property description:

Parameters:

newValue - the value for the menuBarFactory property

See Also:

• getMenuBarFactory()
• menuBarFactoryProperty()

getResources

default @NonNull Resources getResources()

Gets the value of the resources property.

Property description:

Returns:

the value of the resources property

See Also:

• setResources(Resources)
• resourcesProperty()

setResources

default void setResources(@NonNull Resources newValue)

Sets the value of the resources property.

Property description:

Parameters:

newValue - the value for the resources property

See Also:

• getResources()
• resourcesProperty()