com.gluonhq.particle.form

Class FormManager

java.lang.Object

com.gluonhq.particle.form.FormManager

public final class FormManager
extends java.lang.Object

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

See Also:

Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	dispose() This method is called on application shutdown so that the forms can be disposed.
<T extends Form<?>> java.util.Optional<T>	getForm(java.lang.Class<T> formCls, Form.UpdateMode updateMode) 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.
void	init() This method is called on application startup so that the forms can be correctly initialised.
void	registerForm(java.lang.Class<? extends Form<?>> formClass) Registers the given form class - the name that will be used will be read from the ParticleForm.name() value.
void	unregisterForm(java.lang.Class<? extends Form<?>> formClass) Removes the given form from the form manager, and disposes it if it has previously be instantiated.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormManager

public FormManager()

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

Method Detail

init

public void init()

This method is called on application startup so that the forms can be correctly initialised. It should not be called by users, and instead left to Particle to manage.

dispose

public void dispose()

This method is called on application shutdown so that the forms can be disposed. It should not be called by users, and instead left to Particle to manage.

getForm

public <T extends Form<?>> java.util.Optional<T> getForm(java.lang.Class<T> formCls,
                                                         Form.UpdateMode updateMode)

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.

Type Parameters:

T - The class type of the form.

Parameters:

formCls - The class containing the form that is being requested.

updateMode - The update mode to use in the form

Returns:

An Optional that may, if the search parameters match an item, contain the requested form.

registerForm

public void registerForm(java.lang.Class<? extends Form<?>> formClass)

Registers the given form class - the name that will be used will be read from the ParticleForm.name() value. Note that this method only needs to be called in instances where Forms are not automatically discovered due to their @ParticleForm annotation (so, only in rare cases is this method needing to be called).

unregisterForm

public void unregisterForm(java.lang.Class<? extends Form<?>> formClass)

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