Module MaterialFX

Package io.github.palexdev.materialfx.utils.others.loader

Class MFXLoader

java.lang.Object

io.github.palexdev.materialfx.utils.others.loader.MFXLoader

public class MFXLoader
extends Object

Convenience class for creating dashboards, no more hassle on managing multiple views.

This control makes use of LoaderUtils and it's capable of loading multiple FXML views with ExecutorServices.

The informations about a view are stored in bean classes, MFXLoaderBean. Those can be added to this loader by using the various "addView(...)" methods, and will be stored in a Map, every bean is associated to a String, which should be the identifier of the view, you can also use LoaderUtils.generateKey(URL) to automatically generate a key.

Once every view has been added you can start the loader with either start() or startWith(ExecutorService).

After all views have been loaded the onLoaded(List) method is called, see also setOnLoadedAction(Consumer).

This loader has two other notable features:

1) To load FXML files it uses a FXMLLoader of course. But, in some cases (like DI framework) you want to use a specific FXMLLoader, so the loader creates them with a Supplier, see fxmlLoaderSupplierProperty(). The default supplier is just "FXMLLoader::new", but you can easily change that if you need to.

2) To make the views ready for switching the loader can "preload" them (compute both CSS and Layout), you can manage this behavior by setting the "cache level", see setCacheLevel(LoaderCacheLevel) and LoaderCacheLevel

NOTE: the cache level must be set before invoking the start() method.

By default it is set to: LoaderCacheLevel.SCENE_CACHE

See Also:

• LoaderUtils
• MFXLoaderBean

Property Summary

Properties

Type	Property	Description
SupplierProperty<FXMLLoader>	fxmlLoaderSupplier	Specifies the Supplier used to build a new FXMLLoader each time a view has to be loaded.

Constructor Summary

Constructors

Constructor	Description
MFXLoader()
MFXLoader(Consumer<List<MFXLoaderBean>> onLoadedAction)

Method Summary

Modifier and Type	Method	Description
MFXLoader	addView(MFXLoaderBean bean)	Adds the given view to the views map.
MFXLoader	addView(String viewName, URL fxmlFile)	Builds a new MFXLoaderBean with the given identifier and FXML file, then adds it to the views map.
MFXLoader	addView(String viewName, URL fxmlFile, Callback<Class<?>,Object> controllerFactory)	Builds a new MFXLoaderBean with the given identifier, FXML file and controller factory, then adds it to the views map.
SupplierProperty<FXMLLoader>	fxmlLoaderSupplierProperty()	Specifies the Supplier used to build a new FXMLLoader each time a view has to be loaded.
LoaderCacheLevel	getCacheLevel()
Supplier<FXMLLoader>	getFxmlLoaderSupplier()	Gets the value of the fxmlLoaderSupplier property.
Consumer<List<MFXLoaderBean>>	getOnLoadedAction()
MFXLoaderBean	getView(String viewName)
protected void	onLoaded(List<MFXLoaderBean> beans)	This method is called once all the views have been loaded by start() or startWith(ExecutorService).
MFXLoader	setCacheLevel(LoaderCacheLevel cacheLevel)	Sets the LoaderCacheLevel for this loader.
MFXLoader	setFxmlLoaderSupplier(Supplier<FXMLLoader> fxmlLoaderSupplier)
MFXLoader	setOnLoadedAction(Consumer<List<MFXLoaderBean>> onLoadedAction)	Sets the action to perform once all the views have been loaded.
void	start()	Starts the loading process by collecting all the views from the map that are still not loaded.
void	startWith(ExecutorService executorService)	Same as start() but the load tasks are submitted to the given ExecutorService.

Methods inherited from class java.lang.Object

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

Property Details

fxmlLoaderSupplier

public SupplierProperty<FXMLLoader> fxmlLoaderSupplierProperty

Specifies the Supplier used to build a new FXMLLoader each time a view has to be loaded.

See Also:

• getFxmlLoaderSupplier()
• fxmlLoaderSupplierProperty()

Constructor Details

MFXLoader

public MFXLoader()

MFXLoader

public MFXLoader(Consumer<List<MFXLoaderBean>> onLoadedAction)

Method Details

start

public void start()

Starts the loading process by collecting all the views from the map that are still not loaded. Then for each MFXLoaderBean builds the Callable used to load the FXML root, see buildTask(MFXLoaderBean), and sends it to the LoaderUtils's executor, to load the view uses Future.get(). Once the fxml has been loaded invokes cacheParent(Parent) then finally increments the number that keeps track of how many views have been loaded.

At the end of the loop calls onLoaded(List), the list is given by Map.values() (wrapped in an ArrayList).

startWith

public void startWith(ExecutorService executorService)

Same as start() but the load tasks are submitted to the given ExecutorService.

addView

public MFXLoader addView(MFXLoaderBean bean)

Adds the given view to the views map.

addView

public MFXLoader addView(String viewName,
 URL fxmlFile)

Builds a new MFXLoaderBean with the given identifier and FXML file, then adds it to the views map.

addView

public MFXLoader addView(String viewName,
 URL fxmlFile,
 Callback<Class<?>,Object> controllerFactory)

Builds a new MFXLoaderBean with the given identifier, FXML file and controller factory, then adds it to the views map.

getView

public MFXLoaderBean getView(String viewName)

Returns:

a view for the given identifier, or null if no view is found

onLoaded

protected void onLoaded(List<MFXLoaderBean> beans)

This method is called once all the views have been loaded by start() or startWith(ExecutorService).

This simple methods is just responsible for executing the action specified by the user, setOnLoadedAction(Consumer), if not null.

getFxmlLoaderSupplier

public Supplier<FXMLLoader> getFxmlLoaderSupplier()

Gets the value of the fxmlLoaderSupplier property.

Property description:

Specifies the Supplier used to build a new FXMLLoader each time a view has to be loaded.

Returns:

the value of the fxmlLoaderSupplier property

See Also:

• fxmlLoaderSupplierProperty()

fxmlLoaderSupplierProperty

public SupplierProperty<FXMLLoader> fxmlLoaderSupplierProperty()

Specifies the Supplier used to build a new FXMLLoader each time a view has to be loaded.

Returns:

the fxmlLoaderSupplier property

See Also:

• getFxmlLoaderSupplier()

setFxmlLoaderSupplier

public MFXLoader setFxmlLoaderSupplier(Supplier<FXMLLoader> fxmlLoaderSupplier)

getOnLoadedAction

public Consumer<List<MFXLoaderBean>> getOnLoadedAction()

setOnLoadedAction

public MFXLoader setOnLoadedAction(Consumer<List<MFXLoaderBean>> onLoadedAction)

Sets the action to perform once all the views have been loaded.

The action is a Consumer which carries the list fo loaded views.

getCacheLevel

public LoaderCacheLevel getCacheLevel()

setCacheLevel

public MFXLoader setCacheLevel(LoaderCacheLevel cacheLevel)

Sets the LoaderCacheLevel for this loader.