org.eclipse.fx.ui.workbench.fx

Class E4Application

java.lang.Object

org.eclipse.fx.ui.workbench.base.AbstractE4Application

org.eclipse.fx.ui.workbench.fx.E4Application

All Implemented Interfaces:

org.eclipse.equinox.app.IApplication

public class E4Application
extends AbstractE4Application

default e4 application

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.service.event.EventAdmin	eventAdmin

Fields inherited from class org.eclipse.fx.ui.workbench.base.AbstractE4Application

THEME_ID

Fields inherited from interface org.eclipse.equinox.app.IApplication

EXIT_OK, EXIT_RELAUNCH, EXIT_RESTART

Constructor Summary

Constructors

Constructor and Description
E4Application()

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.core.databinding.observable.Realm	createRealm(org.eclipse.e4.core.contexts.IEclipseContext appContext) Create a databinding realm
protected org.eclipse.e4.ui.workbench.IResourceUtilities<javafx.scene.image.Image>	createResourceUtility(org.eclipse.e4.core.contexts.IEclipseContext appContext) Create the utility to handle resources
protected UISynchronize	createSynchronizer(org.eclipse.e4.core.contexts.IEclipseContext appContext) Create a synchronizer instance who synchronizes between UI and none-UI threads
org.eclipse.equinox.app.IApplicationContext	getApplicationContext()
protected java.lang.String	getDefaultPresentationEngineURI(org.eclipse.e4.core.contexts.IEclipseContext appContext) Get the uri of the presentation engine
static @NonNull E4Application	getE4Application() Gets the E4Application.
protected java.lang.Class<? extends javafx.application.Application>	getJfxApplicationClass() Gets the class which should be launched.
boolean	initE4Workbench(org.eclipse.equinox.app.IApplicationContext context, javafx.application.Application jfxApplication, javafx.stage.Stage primaryStage) Initializes the E4Workbench.
void	jfxStart(org.eclipse.equinox.app.IApplicationContext context, javafx.application.Application jfxApplication, javafx.stage.Stage primaryStage) Binds the given Application to the E4Workbench and launches the application.
void	jfxStop() Stops the application.
protected void	launchE4JavaFxApplication() Launches the JavaFX application by calling the Application.launch(Class, String...) method.
protected void	postJfxStarted(org.eclipse.equinox.app.IApplicationContext context) Performs additional actions just after staring the application.
protected void	preLifecycle(org.eclipse.e4.core.contexts.IEclipseContext appContext) Called before the lifecycle handler is created
protected void	sendEvent(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object> map) Sends the event.
java.lang.Object	start(org.eclipse.equinox.app.IApplicationContext context)
void	stop()

Methods inherited from class org.eclipse.fx.ui.workbench.base.AbstractE4Application

checkInstanceLocation, createApplicationContext, createE4Workbench, getApplicationArguments, getArgValue, getLifecycleManager, initializeApplicationServices, initializeServices, initializeWindowServices, initWindowContext, preCreateWorkbench, saveModel

Methods inherited from class java.lang.Object

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

Field Detail

eventAdmin

protected org.osgi.service.event.EventAdmin eventAdmin

Constructor Detail

E4Application

public E4Application()

Method Detail

getE4Application

public static @NonNull E4Application getE4Application()

Gets the E4Application.

The E4Application is not available prior to calling the start(IApplicationContext) by the equinox's launcher.

Returns:

the instance of the E4Application.

start

public java.lang.Object start(org.eclipse.equinox.app.IApplicationContext context)
                       throws java.lang.Exception

Throws:

java.lang.Exception

jfxStart

public void jfxStart(org.eclipse.equinox.app.IApplicationContext context,
                     javafx.application.Application jfxApplication,
                     javafx.stage.Stage primaryStage)

Binds the given Application to the E4Workbench and launches the application.

If the E4Workbench has not been initialized yet then the initE4Workbench method will be called before launching the application.

Parameters:

context - the IApplicationContext.

jfxApplication - the Application.

primaryStage - the primary stage associated with the given Application.

preLifecycle

protected void preLifecycle(org.eclipse.e4.core.contexts.IEclipseContext appContext)

Description copied from class: AbstractE4Application

Called before the lifecycle handler is created

Overrides:

preLifecycle in class AbstractE4Application

Parameters:

appContext - the application context

jfxStop

public void jfxStop()

Stops the application.

stop

public void stop()

initE4Workbench

public boolean initE4Workbench(org.eclipse.equinox.app.IApplicationContext context,
                               javafx.application.Application jfxApplication,
                               javafx.stage.Stage primaryStage)

Initializes the E4Workbench.

By calling this method the E4Workbench is initialized but the UI is not displayed yet. By combining calling this method and the jfxStart method the developer can create a custom initializer which might do additional actions between creating IWorkbench and showing the UI.

Parameters:

context - the IApplicationContext.

jfxApplication - the application which is going to be launched.

primaryStage - the primary stage.

Returns:

true if the workbench was initialized successfully

getApplicationContext

public org.eclipse.equinox.app.IApplicationContext getApplicationContext()

Returns:

the IApplicationContext.

launchE4JavaFxApplication

protected void launchE4JavaFxApplication()
                                  throws java.lang.Exception

Launches the JavaFX application by calling the Application.launch(Class, String...) method.

NOTE: this method is intended to be overridden by subclasses of the E4Application that would like provide a custom application launcher.

Throws:

java.lang.Exception - when the application could not be started.

getJfxApplicationClass

protected java.lang.Class<? extends javafx.application.Application> getJfxApplicationClass()

Gets the class which should be launched. It must be a subclass of the JavaFX's Application.

NOTE: this method is intended to be overridden by subclasses of the E4Application that would like to provide a custom implementation of the Application class.

Returns:

the Class which should be launched.

postJfxStarted

protected void postJfxStarted(org.eclipse.equinox.app.IApplicationContext context)

Performs additional actions just after staring the application.

Parameters:

context - the IApplicationContext.

createSynchronizer

protected UISynchronize createSynchronizer(org.eclipse.e4.core.contexts.IEclipseContext appContext)

Description copied from class: AbstractE4Application

Create a synchronizer instance who synchronizes between UI and none-UI threads

Specified by:

createSynchronizer in class AbstractE4Application

Parameters:

appContext - the context

Returns:

the instance

createRealm

protected org.eclipse.core.databinding.observable.Realm createRealm(org.eclipse.e4.core.contexts.IEclipseContext appContext)

Description copied from class: AbstractE4Application

Create a databinding realm

Specified by:

createRealm in class AbstractE4Application

Parameters:

appContext - the context

Returns:

the realm

createResourceUtility

protected org.eclipse.e4.ui.workbench.IResourceUtilities<javafx.scene.image.Image> createResourceUtility(org.eclipse.e4.core.contexts.IEclipseContext appContext)

Description copied from class: AbstractE4Application

Create the utility to handle resources

Specified by:

createResourceUtility in class AbstractE4Application

Parameters:

appContext - the context

Returns:

the instance

getDefaultPresentationEngineURI

protected java.lang.String getDefaultPresentationEngineURI(org.eclipse.e4.core.contexts.IEclipseContext appContext)

Description copied from class: AbstractE4Application

Get the uri of the presentation engine

Specified by:

getDefaultPresentationEngineURI in class AbstractE4Application

Parameters:

appContext - the context

Returns:

the uri

sendEvent

protected void sendEvent(java.lang.String topic,
                         java.util.Map<java.lang.String,java.lang.Object> map)

Sends the event.

Parameters:

topic - the topic.

map - the payload data.