com.gluonhq.particle.form

Class Form<T extends java.io.Serializable>

java.lang.Object

com.gluonhq.particle.form.Form<T>

Type Parameters:

T - The type of the data model being edited in the form.

public abstract class Form<T extends java.io.Serializable>
extends java.lang.Object

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

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<Form.UpdateMode>	updateMode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Form.Builder Allows adding unlimited number of attributes for controller execution using Fluent Interface pattern
static class	Form.UpdateMode The way in which the form popup dialog works.

Constructor Summary

Constructors

Constructor and Description
Form()
Form(java.util.function.BiFunction<T,Form.UpdateMode,T> finalTask) Constructors

Method Summary

Modifier and Type	Method and Description
Form.Builder	configure(T model) Starts the process of building the form with eventual execution.
Form.Builder	configure(javafx.stage.Window owner, T model)
void	dispose() This method is called on any initialized forms when Particle is shutting down - this is one last chance to clean up.
protected abstract void	exportModel(T model) This method should take the data out of the view controls and set the appropriate fields on the given model object.
protected javafx.scene.Node	getGraphic() Override to specify the graphic to show in the form graphic area.
protected abstract java.lang.String	getMessage() Returns the message to show in the content area of the form popup dialog window, above the form.
protected abstract java.lang.String	getTitle() Returns the title to show in the form popup dialog window.
Form.UpdateMode	getUpdateMode() Gets the value of the property updateMode.
protected abstract javafx.scene.Node	getView() Returns the form itself, which will be displayed in the form popup dialog window beneath the message.
protected abstract void	importModel(T model) This method expects that the given model object will be loaded into the view (e.g.
protected void	initInBackground() Called only the first time this form is shown, just prior to the start() lifecycle method being called.
protected void	postInit() Runs immediately after initInBackground(), and before start(), but on FX thread.
protected void	preInit() Initial initialization on FX thread - this is called when the form is first registered in the Particle FormManager.
void	setUpdateMode(Form.UpdateMode value) Sets the value of the property updateMode.
java.util.Optional<T>	showAndWait(T model) Executes the form and returns optional model
java.util.Optional<T>	showAndWait(javafx.stage.Window owner, T model)
protected void	start() Called immediately prior to showing the form dialog.
protected void	stop() Called immediately after the form dialog is closed.
javafx.beans.property.ObjectProperty<Form.UpdateMode>	updateModeProperty()

Methods inherited from class java.lang.Object

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

Property Detail

updateMode

public final javafx.beans.property.ObjectProperty<Form.UpdateMode> updateModeProperty

See Also:

getUpdateMode(), setUpdateMode(UpdateMode)

Constructor Detail

Form

public Form(java.util.function.BiFunction<T,Form.UpdateMode,T> finalTask)

Constructors

Form

public Form()

Method Detail

getUpdateMode

public final Form.UpdateMode getUpdateMode()

Gets the value of the property updateMode.

setUpdateMode

public final void setUpdateMode(Form.UpdateMode value)

Sets the value of the property updateMode.

updateModeProperty

public final javafx.beans.property.ObjectProperty<Form.UpdateMode> updateModeProperty()

See Also:

getUpdateMode(), setUpdateMode(UpdateMode)

showAndWait

public final java.util.Optional<T> showAndWait(T model)

Executes the form and returns optional model

Parameters:

model -

Returns:

showAndWait

public final java.util.Optional<T> showAndWait(javafx.stage.Window owner,
                                               T model)

configure

public final Form.Builder configure(T model)

Starts the process of building the form with eventual execution. Builder allows for form attributes customization

Parameters:

model -

Returns:

configure

public final Form.Builder configure(javafx.stage.Window owner,
                                    T model)

getTitle

protected abstract java.lang.String getTitle()

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

getGraphic

protected javafx.scene.Node getGraphic()

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

getMessage

protected abstract java.lang.String getMessage()

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

getView

protected abstract javafx.scene.Node getView()

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

importModel

protected abstract void importModel(T model)

This method expects that the given model object will be loaded into the view (e.g. TextFields will be populated with the values taken out of the model, etc).

exportModel

protected abstract void exportModel(T model)

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

preInit

protected void preInit()

Initial initialization on FX thread - this is called when the form is first registered in the Particle FormManager. Only the bare minimum initialization should be performed here.

initInBackground

protected void initInBackground()

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

postInit

protected void postInit()

Runs immediately after initInBackground(), and before start(), but on FX thread. This means that this method is also only called once.

start

protected void start()

Called immediately prior to showing the form dialog.

stop

protected void stop()

Called immediately after the form dialog is closed.

dispose

public void dispose()

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