com.gluonhq.particle.application

Class ParticleApplication

java.lang.Object

javafx.application.Application

com.gluonhq.particle.application.ParticleApplication

public abstract class ParticleApplication
extends javafx.application.Application

Developers may extend the ParticleApplication class to begin building their particle application. By doing this the developer is given an easy starting point for building their software, including a simple life cycle API, as well as built-in management of the stage state between executions (so the application appears with the same positioning and dimensions as when it was last closed).

For these reasons, it is highly recommended that developers choose to build their software by extending from this class. An alternative approach is to create a JavaFX application the usual way (by extending Application), and then creating a Particle instance and setting that inside the application Scene (refer to the Particle class for more detail on this approach).

See Also:

Particle

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	showCloseConfirmation
javafx.beans.property.StringProperty	title

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

javafx.application.Application.Parameters

Field Summary

Fields inherited from class javafx.application.Application

STYLESHEET_CASPIAN, STYLESHEET_MODENA

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParticleApplication() Creates a new instance of ParticleApplication with no name (which is not encouraged).
protected	ParticleApplication(java.lang.String appName) Creates a new instance of ParticleApplication with the given name - this is the recommended approach as the name is used elsewhere in Particle to allow for automatic configuration (by scanning for files with this name, for example).

Method Summary

Modifier and Type	Method and Description
void	exit() It is highly recommended that all attempts to exit Particle be done through this method, as it ensure that the user is prompted that they do indeed wish to exit.
Particle	getParticle() Returns the inner Particle instance that has been instantiated for use inside this ParticleApplication.
javafx.stage.Stage	getPrimaryStage() Returns the primary stage used within this Particle application.
java.lang.String	getTitle() Gets the value of the property title.
boolean	isShowCloseConfirmation() Gets the value of the property showCloseConfirmation.
void	postInit(javafx.scene.Scene scene) This method is called after the application is initialized but before the primary stage is shown to the user.
void	setShowCloseConfirmation(boolean value) Sets the value of the property showCloseConfirmation.
void	setTitle(java.lang.String title) Sets the value of the property title.
javafx.beans.property.BooleanProperty	showCloseConfirmationProperty()
void	start(javafx.stage.Stage primaryStage)
void	stop()
javafx.beans.property.StringProperty	titleProperty()

Methods inherited from class javafx.application.Application

getHostServices, getParameters, getUserAgentStylesheet, init, launch, launch, notifyPreloader, setUserAgentStylesheet

Methods inherited from class java.lang.Object

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

Property Detail

title

public final javafx.beans.property.StringProperty titleProperty

See Also:

getTitle(), setTitle(String)

showCloseConfirmation

public final javafx.beans.property.BooleanProperty showCloseConfirmationProperty

See Also:

isShowCloseConfirmation(), setShowCloseConfirmation(boolean)

Constructor Detail

ParticleApplication

protected ParticleApplication()

Creates a new instance of ParticleApplication with no name (which is not encouraged).

ParticleApplication

protected ParticleApplication(java.lang.String appName)

Creates a new instance of ParticleApplication with the given name - this is the recommended approach as the name is used elsewhere in Particle to allow for automatic configuration (by scanning for files with this name, for example). Refer to the Particle developer documentation for more details.

Method Detail

start

public final void start(javafx.stage.Stage primaryStage)
                 throws java.lang.Exception

Specified by:

start in class javafx.application.Application

Throws:

java.lang.Exception

postInit

public void postInit(javafx.scene.Scene scene)

This method is called after the application is initialized but before the primary stage is shown to the user.

stop

public void stop()
          throws java.lang.Exception

Overrides:

stop in class javafx.application.Application

Throws:

java.lang.Exception

titleProperty

public final javafx.beans.property.StringProperty titleProperty()

See Also:

getTitle(), setTitle(String)

setTitle

public final void setTitle(java.lang.String title)

Sets the value of the property title.

getTitle

public final java.lang.String getTitle()

Gets the value of the property title.

showCloseConfirmationProperty

public final javafx.beans.property.BooleanProperty showCloseConfirmationProperty()

See Also:

isShowCloseConfirmation(), setShowCloseConfirmation(boolean)

setShowCloseConfirmation

public final void setShowCloseConfirmation(boolean value)

Sets the value of the property showCloseConfirmation.

isShowCloseConfirmation

public final boolean isShowCloseConfirmation()

Gets the value of the property showCloseConfirmation.

getParticle

public final Particle getParticle()

Returns the inner Particle instance that has been instantiated for use inside this ParticleApplication.

exit

public final void exit()

It is highly recommended that all attempts to exit Particle be done through this method, as it ensure that the user is prompted that they do indeed wish to exit.

getPrimaryStage

public final javafx.stage.Stage getPrimaryStage()

Returns the primary stage used within this Particle application.