PreferencesFX 11.17.0 · com.dlsc.preferencesfx.model.PreferencesFxModel

Modifier and Type	Field and Description
private BooleanProperty	buttonsVisible
private List<Category>	categories
private ObjectProperty<Category>	displayedCategory
private DoubleProperty	dividerPosition
private final Map<EventType<PreferencesFxEvent>, List<EventHandler<? super PreferencesFxEvent>>>	eventHandlers
private List<Category>	flatCategoriesLst
private History	history
private boolean	historyDebugState
private BooleanProperty	instantPersistent
private static final Logger	LOGGER
private boolean	oneCategoryLayout
private boolean	persistWindowState
private boolean	saveSettings
private SearchHandler	searchHandler
private StringProperty	searchText
private StorageHandler	storageHandler
private ObjectProperty<TranslationService>	translationService

Access	Constructor and Description
public	PreferencesFxModel(StorageHandler the `StorageHandler` to use for saving and loading storageHandler, SearchHandler the `SearchHandler` to use for handling the searches searchHandler, History the `History` in which to save the changes and handle undo / redo history, Category[] the categories to be displayed, along with the groups and settings categories) Initializes a new model.

Method Summary

Modifier and Type	Method and Description
public void	addEventHandler(EventType<PreferencesFxEvent> the type of the events to receive by the handler eventType, EventHandler<? super PreferencesFxEvent> the handler to register eventHandler) Registers an event handler.
private void	applyFieldChanges()
public BooleanProperty	buttonsVisibleProperty()
private void	createBreadcrumbs(List<Category> categories)
public void	discardChanges() Undos all changes made, clears the history and saves the settings.
private void	discardFieldChanges()
public ReadOnlyObjectProperty<Category>	displayedCategoryProperty()
public DoubleProperty	dividerPositionProperty()
private void	fireEvent(PreferencesFxEvent event)
public boolean	getButtonsVisible()
public List<Category>	getCategories()
public Category	getDisplayedCategory()
public double	getDividerPosition()
public List<Category>	getFlatCategoriesLst()
public History	getHistory()
public boolean	getHistoryDebugState()
public SearchHandler	getSearchHandler()
public String	getSearchText()
public StorageHandler	getStorageHandler()
public TranslationService	getTranslationService()
private void	initializeCategoryTranslation() Sets up a binding of the TranslationService on the model, so that the Category's title gets translated properly according to the TranslationService used.
public BooleanProperty	instantPersistentProperty()
public boolean	isInstantPersistent()
public boolean	isOneCategoryLayout()
public boolean	isPersistWindowState()
public boolean	isSaveSettings()
public Category	Returns: last selected Category loadSelectedCategory() Loads the last selected Category before exiting the Preferences window.
public void	loadSettingValues() Load all of the values of the settings using a `StorageHandler` and attaches a listener for `History`, so that it will be notified of changes to the setting's values.
public void	removeEventHandler(EventType<PreferencesFxEvent> the event type from which to unregister eventType, EventHandler<? super PreferencesFxEvent> the handler to unregister eventHandler) Unregisters a previously registered event handler.
public void	saveSelectedCategory() Saves the current selected Category.
public void	saveSettings() Saves the settings, when `isSaveSettings()` returns `true`.
private void	saveSettingValues() Saves all of the values of the settings using a `StorageHandler`.
public StringProperty	searchTextProperty()
public void	setButtonsVisible(boolean buttonsVisible)
public void	setDisplayedCategory(Category displayedCategory)
public void	setDividerPosition(double dividerPosition)
public void	setHistoryDebugState(boolean historyDebugState)
public void	setInstantPersistent(boolean instantPersistent)
public void	setPersistWindowState(boolean persistWindowState)
public void	setSaveSettings(boolean saveSettings)
public void	setSearchText(String searchText)
public void	setTranslationService(TranslationService translationService)
public ObjectProperty<TranslationService>	translationServiceProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

buttonsVisible	back to summary
private BooleanProperty buttonsVisible

categories	back to summary
private List<Category> categories

displayedCategory	back to summary
private ObjectProperty<Category> displayedCategory

dividerPosition	back to summary
private DoubleProperty dividerPosition

eventHandlers	back to summary
private final Map<EventType<PreferencesFxEvent>, List<EventHandler<? super PreferencesFxEvent>>> eventHandlers

flatCategoriesLst	back to summary
private List<Category> flatCategoriesLst

history	back to summary
private History history

historyDebugState	back to summary
private boolean historyDebugState

instantPersistent	back to summary
private BooleanProperty instantPersistent

LOGGER	back to summary
private static final Logger LOGGER

oneCategoryLayout	back to summary
private boolean oneCategoryLayout

persistWindowState	back to summary
private boolean persistWindowState

saveSettings	back to summary
private boolean saveSettings

searchHandler	back to summary
private SearchHandler searchHandler

searchText	back to summary
private StringProperty searchText

storageHandler	back to summary
private StorageHandler storageHandler

translationService	back to summary
private ObjectProperty<TranslationService> translationService

PreferencesFxModel	back to summary
public PreferencesFxModel(StorageHandler storageHandler, SearchHandler searchHandler, History history, Category[] categories) Initializes a new model. Parameters storageHandler:StorageHandler the `StorageHandler` to use for saving and loading searchHandler:SearchHandler the `SearchHandler` to use for handling the searches history:History the `History` in which to save the changes and handle undo / redo categories:Category[] the categories to be displayed, along with the groups and settings

Method Detail

addEventHandler back to summary

addEventHandler	back to summary
public void addEventHandler(EventType<PreferencesFxEvent> eventType, EventHandler<? super PreferencesFxEvent> eventHandler) Registers an event handler. The handler is called when a `PreferencesFxEvent` of the specified type is being fired. Parameters eventType:EventType<PreferencesFxEvent> the type of the events to receive by the handler eventHandler:EventHandler<? super PreferencesFxEvent> the handler to register Exceptions NullPointerException: if the event type or handler is null

public void addEventHandler(EventType<PreferencesFxEvent> eventType, EventHandler<? super PreferencesFxEvent> eventHandler)

Registers an event handler. The handler is called when a PreferencesFxEvent of the specified type is being fired.

Parameters

eventType:EventType<PreferencesFxEvent>: the type of the events to receive by the handler
eventHandler:EventHandler<? super PreferencesFxEvent>: the handler to register

Exceptions

NullPointerException:: if the event type or handler is null

applyFieldChanges	back to summary
private void applyFieldChanges()

buttonsVisibleProperty	back to summary
public BooleanProperty buttonsVisibleProperty()

createBreadcrumbs	back to summary
private void createBreadcrumbs(List<Category> categories)

discardChanges	back to summary
public void discardChanges() Undos all changes made, clears the history and saves the settings. Typically called when the cancel button of the `PreferencesFxDialog` is pressed. Can also be called explicity in case of using PreferencesFX as a node to undo all changes.

discardFieldChanges	back to summary
private void discardFieldChanges()

displayedCategoryProperty	back to summary
public ReadOnlyObjectProperty<Category> displayedCategoryProperty()

dividerPositionProperty	back to summary
public DoubleProperty dividerPositionProperty()

fireEvent	back to summary
private void fireEvent(PreferencesFxEvent event)

getButtonsVisible	back to summary
public boolean getButtonsVisible()

getCategories	back to summary
public List<Category> getCategories()

getDisplayedCategory	back to summary
public Category getDisplayedCategory()

getDividerPosition	back to summary
public double getDividerPosition()

getFlatCategoriesLst	back to summary
public List<Category> getFlatCategoriesLst()

getHistory	back to summary
public History getHistory()

getHistoryDebugState	back to summary
public boolean getHistoryDebugState()

getSearchHandler	back to summary
public SearchHandler getSearchHandler()

getSearchText	back to summary
public String getSearchText()

getStorageHandler	back to summary
public StorageHandler getStorageHandler()

getTranslationService	back to summary
public TranslationService getTranslationService()

initializeCategoryTranslation	back to summary
private void initializeCategoryTranslation() Sets up a binding of the TranslationService on the model, so that the Category's title gets translated properly according to the TranslationService used.

instantPersistentProperty	back to summary
public BooleanProperty instantPersistentProperty()

isInstantPersistent	back to summary
public boolean isInstantPersistent()

isOneCategoryLayout	back to summary
public boolean isOneCategoryLayout()

isPersistWindowState	back to summary
public boolean isPersistWindowState()

isSaveSettings	back to summary
public boolean isSaveSettings()

loadSelectedCategory	back to summary
public Category loadSelectedCategory() Loads the last selected Category before exiting the Preferences window. Returns:Category last selected Category

loadSelectedCategory

back to summary

public Category loadSelectedCategory()

Loads the last selected Category before exiting the Preferences window.

Returns:Category: last selected Category

loadSettingValues	back to summary
public void loadSettingValues() Load all of the values of the settings using a `StorageHandler` and attaches a listener for `History`, so that it will be notified of changes to the setting's values.

removeEventHandler	back to summary
public void removeEventHandler(EventType<PreferencesFxEvent> eventType, EventHandler<? super PreferencesFxEvent> eventHandler) Unregisters a previously registered event handler. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler. Parameters eventType:EventType<PreferencesFxEvent> the event type from which to unregister eventHandler:EventHandler<? super PreferencesFxEvent> the handler to unregister Exceptions NullPointerException: if the event type or handler is null

removeEventHandler

back to summary

public void removeEventHandler(EventType<PreferencesFxEvent> eventType, EventHandler<? super PreferencesFxEvent> eventHandler)

Unregisters a previously registered event handler. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

Parameters

eventType:EventType<PreferencesFxEvent>: the event type from which to unregister
eventHandler:EventHandler<? super PreferencesFxEvent>: the handler to unregister

Exceptions

NullPointerException:: if the event type or handler is null

saveSelectedCategory	back to summary
public void saveSelectedCategory() Saves the current selected Category.

saveSettings	back to summary
public void saveSettings() Saves the settings, when `isSaveSettings()` returns `true`.

saveSettingValues	back to summary
private void saveSettingValues() Saves all of the values of the settings using a `StorageHandler`.

searchTextProperty	back to summary
public StringProperty searchTextProperty()

setButtonsVisible	back to summary
public void setButtonsVisible(boolean buttonsVisible)

setDisplayedCategory	back to summary
public void setDisplayedCategory(Category displayedCategory)

setDividerPosition	back to summary
public void setDividerPosition(double dividerPosition)

setHistoryDebugState	back to summary
public void setHistoryDebugState(boolean historyDebugState)

setInstantPersistent	back to summary
public void setInstantPersistent(boolean instantPersistent)

setPersistWindowState	back to summary
public void setPersistWindowState(boolean persistWindowState)

setSaveSettings	back to summary
public void setSaveSettings(boolean saveSettings)

setSearchText	back to summary
public void setSearchText(String searchText)

setTranslationService	back to summary
public void setTranslationService(TranslationService translationService)

translationServiceProperty	back to summary
public ObjectProperty<TranslationService> translationServiceProperty()

public Class PreferencesFxModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail