com.gluonhq.particle.view

Class ViewManager

java.lang.Object

com.gluonhq.particle.view.ViewManager

public final class ViewManager
extends java.lang.Object

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

See Also:

View

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<View>	currentView Property representing the currently set view inside this ViewManager instance.

Constructor Summary

Constructors

Constructor and Description
ViewManager() Creates a new ViewManager 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
javafx.beans.property.ObjectProperty<View>	currentViewProperty() Property representing the currently set view inside this ViewManager instance.
void	dispose() This method is called on application shutdown so that the views can be disposed.
View	getCurrentView() Gets the value of the property currentView.
void	init() This method is called on application startup so that the views can be correctly initialised.
void	registerView(java.lang.Class<? extends View> viewClass) Registers the given view class - the name that will be used will be read from the ParticleView.name() value.
void	setCurrentView(View value) Sets the value of the property currentView.
void	switchView(java.lang.Class<? extends View> viewCls) This will attempt to remove the current view, and replace it with the given view class.
void	switchView(java.lang.String viewName) This will attempt to remove the current view, and replace it with the view with the given name.
void	unregisterView(java.lang.Class<? extends View> viewClass) Removes the given view from the view 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

Property Detail

currentView

public final javafx.beans.property.ObjectProperty<View> currentViewProperty

Property representing the currently set view inside this ViewManager instance.

See Also:

getCurrentView(), setCurrentView(View)

Constructor Detail

ViewManager

public ViewManager()

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

Method Detail

getCurrentView

public final View getCurrentView()

Gets the value of the property currentView.

Property description:

Property representing the currently set view inside this ViewManager instance.

setCurrentView

public final void setCurrentView(View value)

Sets the value of the property currentView.

Property description:

Property representing the currently set view inside this ViewManager instance.

currentViewProperty

public final javafx.beans.property.ObjectProperty<View> currentViewProperty()

Property representing the currently set view inside this ViewManager instance.

See Also:

getCurrentView(), setCurrentView(View)

init

public void init()

This method is called on application startup so that the views 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 views can be disposed. It should not be called by users, and instead left to Particle to manage.

switchView

public void switchView(java.lang.Class<? extends View> viewCls)

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

switchView

public void switchView(java.lang.String viewName)

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

registerView

public void registerView(java.lang.Class<? extends View> viewClass)

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

unregisterView

public void unregisterView(java.lang.Class<? extends View> viewClass)

Removes the given view from the view manager, and disposes it if it has previously be instantiated. If the view is currently being displayed, it will be removed, but nothing will be put in its place.