B C D E F G I L M O P R S T U V

B

Builder(Window, T) - Constructor for class com.gluonhq.particle.form.Form.Builder

buildMenu(String...) - Method in class com.gluonhq.particle.application.Particle

Convenience API to allow for easy specification of menu structures.

C

cancelButton(String) - Method in class com.gluonhq.particle.form.Form.Builder

closeButton(String) - Method in class com.gluonhq.particle.form.Form.Builder

com.gluonhq.particle.annotation - package com.gluonhq.particle.annotation

com.gluonhq.particle.application - package com.gluonhq.particle.application

com.gluonhq.particle.form - package com.gluonhq.particle.form

com.gluonhq.particle.state - package com.gluonhq.particle.state

com.gluonhq.particle.state.impl - package com.gluonhq.particle.state.impl

com.gluonhq.particle.view - package com.gluonhq.particle.view

configure(T) - Method in class com.gluonhq.particle.form.Form

Starts the process of building the form with eventual execution.

configure(Window, T) - Method in class com.gluonhq.particle.form.Form

currentViewProperty() - Method in class com.gluonhq.particle.view.ViewManager

Property representing the currently set view inside this ViewManager instance.

D

dispose() - Method in class com.gluonhq.particle.form.Form

This method is called on any initialized forms when Particle is shutting down - this is one last chance to clean up.

dispose() - Method in class com.gluonhq.particle.form.FormManager

This method is called on application shutdown so that the forms can be disposed.

dispose() - Method in class com.gluonhq.particle.state.impl.PropertiesFileStateIO

Disposes of the state IO implementation.

dispose() - Method in interface com.gluonhq.particle.state.StateIO

Disposes of the state IO implementation.

dispose() - Method in class com.gluonhq.particle.state.StateManager

This method is called on application shutdown so that the system state can be flushed and disposed appropriately.

dispose() - Method in interface com.gluonhq.particle.view.View

Called on application shutdown to allow any resources to be closed properly.

dispose() - Method in class com.gluonhq.particle.view.ViewManager

This method is called on application shutdown so that the views can be disposed.

E

exit() - Method in class com.gluonhq.particle.application.ParticleApplication

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.

exportModel(T) - Method in class com.gluonhq.particle.form.Form

This method should take the data out of the view controls and set the appropriate fields on the given model object.

F

Form<T extends java.io.Serializable> - Class in com.gluonhq.particle.form

Base class for all forms that are shown in a Gluon Particle application.

Form(BiFunction<T, Form.UpdateMode, T>) - Constructor for class com.gluonhq.particle.form.Form

Constructors

Form() - Constructor for class com.gluonhq.particle.form.Form

Form.Builder - Class in com.gluonhq.particle.form

Allows adding unlimited number of attributes for controller execution using Fluent Interface pattern

Form.UpdateMode - Enum in com.gluonhq.particle.form

The way in which the form popup dialog works.

FormManager - Class in com.gluonhq.particle.form

The FormManager is responsible for discovering, initializing, displaying, and disposing of Particle forms.

FormManager() - Constructor for class com.gluonhq.particle.form.FormManager

Creates a new FormManager instance - this should not be called by users, and instead should be left to Particle to manage.

FXMLView - Class in com.gluonhq.particle.view

An implementation of View specifically intended to improve support for FXML-based views.

FXMLView(URL) - Constructor for class com.gluonhq.particle.view.FXMLView

Creates a new FXMLView instance with the given fxmlFile as the view that will be loaded.

G

getContent() - Method in class com.gluonhq.particle.view.FXMLView

Returns the root node of this view - this will be displayed in the center area of the Particle window.

getContent() - Method in interface com.gluonhq.particle.view.View

Returns the root node of this view - this will be displayed in the center area of the Particle window.

getController() - Method in class com.gluonhq.particle.view.FXMLView

getCurrentView() - Method in class com.gluonhq.particle.view.ViewManager

Gets the value of the property currentView.

getForm(Class<T>, Form.UpdateMode) - Method in class com.gluonhq.particle.form.FormManager

Attempts to return the form represented by the given class (which is a class that extends from Form), with the form configured to operate in the given update mode.

getFormManager() - Method in class com.gluonhq.particle.application.Particle

Returns the instance of the FormManager that is in use in this Particle application.

getGraphic() - Method in class com.gluonhq.particle.form.Form

Override to specify the graphic to show in the form graphic area.

getMenuActions() - Method in class com.gluonhq.particle.application.Particle

Returns a list containing all actions that are currently installed on the MenuBar control.

getMessage() - Method in class com.gluonhq.particle.form.Form

Returns the message to show in the content area of the form popup dialog window, above the form.

getParticle() - Method in class com.gluonhq.particle.application.ParticleApplication

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

getPersistenceMode() - Method in class com.gluonhq.particle.state.StateManager

Gets the value of the property persistenceMode.

getPrimaryStage() - Method in class com.gluonhq.particle.application.ParticleApplication

Returns the primary stage used within this Particle application.

getProperty(Object) - Method in class com.gluonhq.particle.state.impl.PropertiesFileStateIO

Returns an Optional that may contain a value represented by the given key.

getProperty(Object) - Method in interface com.gluonhq.particle.state.StateIO

Returns an Optional that may contain a value represented by the given key.

getProperty(Object) - Method in class com.gluonhq.particle.state.StateManager

Returns an Optional that may contain a value represented by the given key.

getPropertyAsBoolean(Object) - Method in class com.gluonhq.particle.state.StateManager

Returns an Optional<Boolean> that may contain a value represented by the given key.

getPropertyAsDouble(Object) - Method in class com.gluonhq.particle.state.StateManager

Returns an Optional<Double> that may contain a value represented by the given key.

getPropertyAsInteger(Object) - Method in class com.gluonhq.particle.state.StateManager

Returns an Optional<Integer> that may contain a value represented by the given key.

getPropertyAsString(Object) - Method in class com.gluonhq.particle.state.StateManager

Returns an Optional<String> that may contain a value represented by the given key.

getStateIO() - Method in class com.gluonhq.particle.state.StateManager

Gets the value of the property stateIO.

getStateManager() - Method in class com.gluonhq.particle.application.Particle

Returns the instance of the StateManager that is in use in this Particle application.

getStatusBar() - Method in class com.gluonhq.particle.application.Particle

Returns the StatusBar control, allowing the developer to make any desired changes to the status bar area of the application view.

getTitle() - Method in class com.gluonhq.particle.application.ParticleApplication

Gets the value of the property title.

getTitle() - Method in class com.gluonhq.particle.form.Form

Returns the title to show in the form popup dialog window.

getToolBarActions() - Method in class com.gluonhq.particle.application.Particle

Returns a list containing all actions that are currently installed on the ToolBar control.

getUpdateMode() - Method in class com.gluonhq.particle.form.Form

Gets the value of the property updateMode.

getValidationSupport() - Method in class com.gluonhq.particle.form.Form

This method, when called initializes validation support

getView() - Method in class com.gluonhq.particle.form.Form

Returns the form itself, which will be displayed in the form popup dialog window beneath the message.

getViewManager() - Method in class com.gluonhq.particle.application.Particle

Returns the instance of the ViewManager that is in use in this Particle application.

I

importModel(T) - Method in class com.gluonhq.particle.form.Form

This method expects that the given model object will be loaded into the view (e.g.

init() - Method in class com.gluonhq.particle.form.FormManager

This method is called on application startup so that the forms can be correctly initialised.

init() - Method in class com.gluonhq.particle.state.impl.PropertiesFileStateIO

Initializes the state IO implementation.

init() - Method in interface com.gluonhq.particle.state.StateIO

Initializes the state IO implementation.

init() - Method in class com.gluonhq.particle.state.StateManager

This method is called on application startup so that the system state can be correctly initialised.

init() - Method in interface com.gluonhq.particle.view.View

Called when the view is first initialised, but after any dependency injection has occurred.

init() - Method in class com.gluonhq.particle.view.ViewManager

This method is called on application startup so that the views can be correctly initialised.

initInBackground() - Method in class com.gluonhq.particle.form.Form

Called only the first time this form is shown, just prior to the start() lifecycle method being called.

isShowCloseConfirmation() - Method in class com.gluonhq.particle.application.ParticleApplication

Gets the value of the property showCloseConfirmation.

L

License - Annotation Type in com.gluonhq.particle.annotation

License Annotation for Particle applications.

M

modality(Modality) - Method in class com.gluonhq.particle.form.Form.Builder

O

okButton(String) - Method in class com.gluonhq.particle.form.Form.Builder

P

Particle - Class in com.gluonhq.particle.application

The Particle class is at the epicenter of the Particle application framework.

Particle() - Constructor for class com.gluonhq.particle.application.Particle

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

Particle(String) - Constructor for class com.gluonhq.particle.application.Particle

Creates a new instance of Particle 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).

ParticleActions - Annotation Type in com.gluonhq.particle.annotation

Annotation for classes that contain one or more ActionProxy annotations.

ParticleApplication - Class in com.gluonhq.particle.application

Developers may extend the ParticleApplication class to begin building their particle application.

ParticleApplication() - Constructor for class com.gluonhq.particle.application.ParticleApplication

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

ParticleApplication(String) - Constructor for class com.gluonhq.particle.application.ParticleApplication

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).

ParticleForm - Annotation Type in com.gluonhq.particle.annotation

Annotation for classes that extend from Form.

ParticleView - Annotation Type in com.gluonhq.particle.annotation

Annotation for classes that implement the View interface.

persistenceModeProperty() - Method in class com.gluonhq.particle.state.StateManager

postInit(Scene) - Method in class com.gluonhq.particle.application.ParticleApplication

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

postInit() - Method in class com.gluonhq.particle.form.Form

Runs immediately after initInBackground(), and before start(), but on FX thread.

preInit() - Method in class com.gluonhq.particle.form.Form

Initial initialization on FX thread - this is called when the form is first registered in the Particle FormManager.

PropertiesFileStateIO - Class in com.gluonhq.particle.state.impl

A StateIO implementation that simply persists all state to the file system as properties files.

PropertiesFileStateIO() - Constructor for class com.gluonhq.particle.state.impl.PropertiesFileStateIO

Creates a default instance of the PropertiesFileStateIO class.

R

registerActions(Class<?>) - Method in class com.gluonhq.particle.application.Particle

Call this method to register with Particle a class that contains one or more methods annotated with the ActionProxy annotation.

registerForm(Class<? extends Form<?>>) - Method in class com.gluonhq.particle.form.FormManager

Registers the given form class - the name that will be used will be read from the ParticleForm.name() value.

registerView(Class<? extends View>) - Method in class com.gluonhq.particle.view.ViewManager

Registers the given view class - the name that will be used will be read from the name() value.

resizable(boolean) - Method in class com.gluonhq.particle.form.Form.Builder

S

setContent(Node) - Method in class com.gluonhq.particle.application.Particle

This sets the content in the main view area of the Particle application.

setCurrentView(View) - Method in class com.gluonhq.particle.view.ViewManager

Sets the value of the property currentView.

setPersistenceMode(StateManager.PersistenceMode) - Method in class com.gluonhq.particle.state.StateManager

Sets the value of the property persistenceMode.

setProperty(Object, Object) - Method in class com.gluonhq.particle.state.impl.PropertiesFileStateIO

Attempts to set the given value under the given key.

setProperty(Object, Object) - Method in interface com.gluonhq.particle.state.StateIO

Attempts to set the given value under the given key.

setProperty(Object, Object) - Method in class com.gluonhq.particle.state.StateManager

Sets the given property under the given key.

setShowCloseConfirmation(boolean) - Method in class com.gluonhq.particle.application.ParticleApplication

Sets the value of the property showCloseConfirmation.

setStateIO(StateIO) - Method in class com.gluonhq.particle.state.StateManager

Sets the value of the property stateIO.

setTitle(String) - Method in class com.gluonhq.particle.application.ParticleApplication

Sets the value of the property title.

setUpdateMode(Form.UpdateMode) - Method in class com.gluonhq.particle.form.Form

Sets the value of the property updateMode.

showAndWait() - Method in class com.gluonhq.particle.form.Form.Builder

showAndWait(T) - Method in class com.gluonhq.particle.form.Form

Executes the form and returns optional model

showAndWait(Window, T) - Method in class com.gluonhq.particle.form.Form

showCloseConfirmationProperty() - Method in class com.gluonhq.particle.application.ParticleApplication

start(Stage) - Method in class com.gluonhq.particle.application.ParticleApplication

start() - Method in class com.gluonhq.particle.form.Form

Called immediately prior to showing the form dialog.

start() - Method in interface com.gluonhq.particle.view.View

Called just prior to the view being made visible to the user.

StateIO - Interface in com.gluonhq.particle.state

Interface to be implemented by any StateIO implementations that can then be used in the StateManager.

stateIOProperty() - Method in class com.gluonhq.particle.state.StateManager

StateManager - Class in com.gluonhq.particle.state

The FormManager is responsible for reading in, and writing out, application state information in an implementation-agnostic fashion.

StateManager() - Constructor for class com.gluonhq.particle.state.StateManager

Creates a new StateManager instance - this should not be called by users, and instead should be left to Particle to manage.

StateManager.PersistenceMode - Enum in com.gluonhq.particle.state

The StateManager may operate in one of two persistence modes.

stop() - Method in class com.gluonhq.particle.application.ParticleApplication

stop() - Method in class com.gluonhq.particle.form.Form

Called immediately after the form dialog is closed.

stop() - Method in interface com.gluonhq.particle.view.View

Called just before the view is removed from the user interface and hidden from the user.

switchView(Class<? extends View>) - Method in class com.gluonhq.particle.view.ViewManager

This will attempt to remove the current view, and replace it with the given view class.

switchView(String) - Method in class com.gluonhq.particle.view.ViewManager

This will attempt to remove the current view, and replace it with the view with the given name.

T

titleProperty() - Method in class com.gluonhq.particle.application.ParticleApplication

U

unregisterActions(Class<?>) - Method in class com.gluonhq.particle.application.Particle

Removes a previously-registered (using Particle.registerActions(Class)) actions class from Particle.

unregisterForm(Class<? extends Form<?>>) - Method in class com.gluonhq.particle.form.FormManager

Removes the given form from the form manager, and disposes it if it has previously be instantiated.

unregisterView(Class<? extends View>) - Method in class com.gluonhq.particle.view.ViewManager

Removes the given view from the view manager, and disposes it if it has previously be instantiated.

updateModeProperty() - Method in class com.gluonhq.particle.form.Form

V

valueOf(String) - Static method in enum com.gluonhq.particle.form.Form.UpdateMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.gluonhq.particle.state.StateManager.PersistenceMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.gluonhq.particle.form.Form.UpdateMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.gluonhq.particle.state.StateManager.PersistenceMode

Returns an array containing the constants of this enum type, in the order they are declared.

View - Interface in com.gluonhq.particle.view

All views in Particle implement the View interface, as it is through this interface that a view life cycle can be ensured.

ViewManager - Class in com.gluonhq.particle.view

The ViewManager is responsible for discovering, initializing, displaying, and disposing of Particle views.

ViewManager() - Constructor for class com.gluonhq.particle.view.ViewManager

Creates a new ViewManager instance - this should not be called by users, and instead should be left to Particle to manage.

B C D E F G I L M O P R S T U V