net.bbmsoft.iocfx

Interface StageService

@ProviderType
public interface StageService

This service provides instances of Stage. Components declaring a dependency on it like this will receive their own Stage instance:

 @Reference(scope = ReferenceScope.PROTOTYPE_REQUIRED)
 private StageService stageService;
 

While this was the default way to acquire an application's main stage in the first release of IoCFX, its use is now discouraged, as the Fxml.Application and Standalone.Application interfaces provide a much more convenient way to create a main stage.

While developers of multi-window applications may still find this service useful, simply directly constructing new Stage objects may be the more convenient approach.

Author:

Michael Bachmann

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StageService.ExitPolicy Enum to determine the behavior of an application when a Stage is closed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DO_NOTHING_ON_STAGE_EXIT
static String	EXIT_POLICY

Method Summary

Modifier and Type	Method and Description
javafx.stage.Stage	getStage() Gets the Stage instance provided by this service.
void	setExitPolicy(StageService.ExitPolicy policy, Class<?>... bundleClasses) Specifies what should happen when the Stage provided by this service is closed.

Field Detail

EXIT_POLICY

static final String EXIT_POLICY

DO_NOTHING_ON_STAGE_EXIT

static final String DO_NOTHING_ON_STAGE_EXIT

Method Detail

getStage

javafx.stage.Stage getStage()

Gets the Stage instance provided by this service.

Returns:

the Stage instance provided by this service

setExitPolicy

void setExitPolicy(StageService.ExitPolicy policy,
                   Class<?>... bundleClasses)

Specifies what should happen when the Stage provided by this service is closed. There are three possibilities:

1. SHUTDOWN_ON_STAGE_EXIT (the default behavior):
   tries to shutdown the OSGi framework when the stage is closed. Use this for the main window of desktop applications
2. STOP_BUNDLE_ON_STAGE_EXIT:
   stop one or several bundles when the stage is closed. For this option a class from every bundle that should be stopped needs to be provided. Mainly useful for testing and debugging
3. DO_NOTHING_ON_STAGE_EXIT:
   does nothing when the stage is closed. This should be used for secondary windows or when several UI applications are running in the same framework

Default value:

ExitPolicy.SHUTDOWN_ON_STAGE_EXIT

Parameters:

policy - the policy to be applied when the Stage provided by this service is closed

bundleClasses - classes from all bundles that should be stopped when the stage is closed. Only required for STOP_BUNDLE_ON_STAGE_EXIT