PreferencesFX 11.17.0 · com.dlsc.preferencesfx.PreferencesFx

Modifier and Type	Field and Description
private BreadCrumbPresenter	breadCrumbPresenter
private BreadCrumbView	breadCrumbView
private CategoryController	categoryController
private static final Logger	LOGGER
private NavigationPresenter	navigationPresenter
private NavigationView	navigationView
private PreferencesFxDialog	preferencesFxDialog
private PreferencesFxModel	preferencesFxModel
private PreferencesFxPresenter	preferencesFxPresenter
private PreferencesFxView	preferencesFxView
private UndoRedoBox	undoRedoBox

Access	Constructor and Description
private	PreferencesFx(Class<?> saveClass, Category... categories)
private	PreferencesFx(StorageHandler storageHandler, Category... categories)

Method Summary

Modifier and Type	Method and Description
public PreferencesFx	Returns: PreferencesFx to allow for chaining. 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 with the model.
public PreferencesFx	buttonsVisibility(boolean isVisible)
public PreferencesFx	Returns: this object for fluent API debugHistoryMode(boolean if true, pressing the key combination will open the dialog debugState) Defines whether the table to debug the undo / redo history should be shown in a dialog when pressing a key combination or not.
public PreferencesFx	Returns: PreferencesFx to allow for chaining. dialogIcon(Image the image to be used as the dialog icon. image) Sets the dialog icon.
public PreferencesFx	Returns: PreferencesFx to allow for chaining. dialogTitle(String the dialog title title) Sets the dialog title.
public void	discardChanges() Call this method to undo all changes made in the settings when showing the preferences by using `getView()`.
public ObservableList<String>	Returns: the stylesheets List of the PreferenceFxDialog getStylesheets() Return the stylesheets of the PreferenceFxDialog.
public PreferencesFxView	Returns: a PreferencesFxView, so that it can be used as a Node. getView() Returns a PreferencesFxView, so that it can be used as a Node.
public PreferencesFx	Returns: PreferencesFx to allow for chaining. i18n(TranslationService The new value for the translation service property. newValue) Sets the translation service property of the preferences dialog.
private void	init()
private void	initializeCategoryViews() Prepares the CategoryController by creating CategoryView / CategoryPresenter pairs from all Categories and loading them into the CategoryController.
public PreferencesFx	Returns: this object for fluent API instantPersistent(boolean if true, will instantly persist changes instantPersistent) Defines whether changes should be instantly persisted or not.
public boolean	Returns: true if there are unsaved changed. isContainingChanges() Check if any changes are pending.
public static PreferencesFx	Returns: the preferences window of(Class<?> the class which the preferences are saved as Must be unique to the application using the preferences saveClass, Category... the items to be displayed in the TreeSearchView categories) Creates the Preferences window.
public static PreferencesFx	Returns: the preferences window of(StorageHandler Custom implementation of the `StorageHandler` customStorageHandler, Category... the items to be displayed in the TreeSearchView categories) Creates the Preferences window.
public PreferencesFx	Returns: this object for fluent API persistApplicationState(boolean if true, the storing of the window state of the dialog window and the settings values are enabled. enable) Defines if the PreferencesAPI should save the applications states.
public PreferencesFx	Returns: this object for fluent API persistWindowState(boolean if true, the size, position and last selected item in the TreeSearchView are being saved. When the dialog is showed again, it will be restored to the last saved state. Defaults to false. persist) Defines whether the state of the dialog window should be persisted or not.
public PreferencesFx	Returns: PreferencesFx to allow for chaining. 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 from the model.
public PreferencesFx	Returns: this object for fluent API saveSettings(boolean if true, the values of all settings of the application are saved. When the application is started again, the settings values will be restored to the last saved state. Defaults to true. save) Defines whether the adjusted settings of the application should be saved or not.
public void	saveSettings() Call this method to manually save the changed settings when showing the preferences by using `getView()`.
public void	show() Shows the PreferencesFX dialog.
public void	show(boolean window or not modal, that's the question. modal) Show the PreferencesFX dialog.

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

breadCrumbPresenter	back to summary
private BreadCrumbPresenter breadCrumbPresenter

breadCrumbView	back to summary
private BreadCrumbView breadCrumbView

categoryController	back to summary
private CategoryController categoryController

LOGGER	back to summary
private static final Logger LOGGER

preferencesFxDialog	back to summary
private PreferencesFxDialog preferencesFxDialog

preferencesFxModel	back to summary
private PreferencesFxModel preferencesFxModel

preferencesFxPresenter	back to summary
private PreferencesFxPresenter preferencesFxPresenter

preferencesFxView	back to summary
private PreferencesFxView preferencesFxView

undoRedoBox	back to summary
private UndoRedoBox undoRedoBox

PreferencesFx	back to summary
private PreferencesFx(Class<?> saveClass, Category... categories)

PreferencesFx	back to summary
private PreferencesFx(StorageHandler storageHandler, Category... categories)

Method Detail

addEventHandler back to summary

addEventHandler	back to summary
public PreferencesFx addEventHandler(EventType<PreferencesFxEvent> eventType, EventHandler<? super PreferencesFxEvent> eventHandler) Registers an event handler with the model. The handler is called when the model receives an `Event` of the specified type during the bubbling phase of event delivery. Parameters eventType:EventType<PreferencesFxEvent> the type of the events to receive by the handler eventHandler:EventHandler<? super PreferencesFxEvent> the handler to register Returns:PreferencesFx PreferencesFx to allow for chaining. Exceptions NullPointerException: if either event type or handler are `null`.

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

Registers an event handler with the model. The handler is called when the model receives an Event of the specified type during the bubbling phase of event delivery.

Parameters

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

Returns:PreferencesFx

PreferencesFx to allow for chaining.

Exceptions

NullPointerException:: if either event type or handler are null.

buttonsVisibility	back to summary
public PreferencesFx buttonsVisibility(boolean isVisible)

debugHistoryMode	back to summary
public PreferencesFx debugHistoryMode(boolean debugState) Defines whether the table to debug the undo / redo history should be shown in a dialog when pressing a key combination or not. Pressing Ctrl + Shift + H (Windows) or CMD + Shift + H (Mac) opens a dialog with the undo / redo history, shown in a table. Parameters debugState:boolean if true, pressing the key combination will open the dialog Returns:PreferencesFx this object for fluent API

debugHistoryMode

back to summary

public PreferencesFx debugHistoryMode(boolean debugState)

Defines whether the table to debug the undo / redo history should be shown in a dialog when pressing a key combination or not.
Pressing Ctrl + Shift + H (Windows) or CMD + Shift + H (Mac) opens a dialog with the undo / redo history, shown in a table.

Parameters

debugState:boolean: if true, pressing the key combination will open the dialog

Returns:PreferencesFx

this object for fluent API

dialogIcon	back to summary
public PreferencesFx dialogIcon(Image image) Sets the dialog icon. Parameters image:Image the image to be used as the dialog icon. Returns:PreferencesFx PreferencesFx to allow for chaining.

dialogIcon

back to summary

public PreferencesFx dialogIcon(Image image)

Sets the dialog icon.

Parameters

image:Image: the image to be used as the dialog icon.

Returns:PreferencesFx

PreferencesFx to allow for chaining.

dialogTitle	back to summary
public PreferencesFx dialogTitle(String title) Sets the dialog title. Parameters title:String the dialog title Returns:PreferencesFx PreferencesFx to allow for chaining.

dialogTitle

back to summary

public PreferencesFx dialogTitle(String title)

Sets the dialog title.

Parameters

title:String: the dialog title

Returns:PreferencesFx

PreferencesFx to allow for chaining.

discardChanges	back to summary
public void discardChanges() Call this method to undo all changes made in the settings when showing the preferences by using `getView()`.

getStylesheets	back to summary
public ObservableList<String> getStylesheets() Return the stylesheets of the PreferenceFxDialog. Returns:ObservableList<String> the stylesheets List of the PreferenceFxDialog

getStylesheets

back to summary

public ObservableList<String> getStylesheets()

Return the stylesheets of the PreferenceFxDialog.

Returns:ObservableList<String>: the stylesheets List of the PreferenceFxDialog

getView	back to summary
public PreferencesFxView getView() Returns a PreferencesFxView, so that it can be used as a Node. Returns:PreferencesFxView a PreferencesFxView, so that it can be used as a Node.

getView

back to summary

public PreferencesFxView getView()

Returns a PreferencesFxView, so that it can be used as a Node.

Returns:PreferencesFxView: a PreferencesFxView, so that it can be used as a Node.

i18n	back to summary
public PreferencesFx i18n(TranslationService newValue) Sets the translation service property of the preferences dialog. Parameters newValue:TranslationService The new value for the translation service property. Returns:PreferencesFx PreferencesFx to allow for chaining.

i18n

back to summary

public PreferencesFx i18n(TranslationService newValue)

Sets the translation service property of the preferences dialog.

Parameters

newValue:TranslationService: The new value for the translation service property.

Returns:PreferencesFx

PreferencesFx to allow for chaining.

init	back to summary
private void init()

initializeCategoryViews	back to summary
private void initializeCategoryViews() Prepares the CategoryController by creating CategoryView / CategoryPresenter pairs from all Categories and loading them into the CategoryController.

instantPersistent back to summary

instantPersistent	back to summary
public PreferencesFx instantPersistent(boolean instantPersistent) Defines whether changes should be instantly persisted or not. When `instantPersistent` is false, call `saveSettings()` to apply the changes. Parameters instantPersistent:boolean if true, will instantly persist changes Returns:PreferencesFx this object for fluent API

public PreferencesFx instantPersistent(boolean instantPersistent)

Defines whether changes should be instantly persisted or not. When instantPersistent is false, call saveSettings() to apply the changes.

Parameters

instantPersistent:boolean: if true, will instantly persist changes

Returns:PreferencesFx

this object for fluent API

isContainingChanges	back to summary
public boolean isContainingChanges() Check if any changes are pending. Useful when manually saving settings. Returns:boolean true if there are unsaved changed.

isContainingChanges

back to summary

public boolean isContainingChanges()

Check if any changes are pending. Useful when manually saving settings.

Returns:boolean: true if there are unsaved changed.

of	back to summary
public static PreferencesFx of(Class<?> saveClass, Category... categories) Creates the Preferences window. Parameters saveClass:Class<?> the class which the preferences are saved as Must be unique to the application using the preferences categories:Category[] the items to be displayed in the TreeSearchView Returns:PreferencesFx the preferences window

back to summary

public static PreferencesFx of(Class<?> saveClass, Category... categories)

Creates the Preferences window.

Parameters

saveClass:Class<?>: the class which the preferences are saved as Must be unique to the application using the preferences
categories:Category[]: the items to be displayed in the TreeSearchView

Returns:PreferencesFx

the preferences window

of back to summary

of	back to summary
public static PreferencesFx of(StorageHandler customStorageHandler, Category... categories) Creates the Preferences window. Parameters customStorageHandler:StorageHandler Custom implementation of the `StorageHandler` categories:Category[] the items to be displayed in the TreeSearchView Returns:PreferencesFx the preferences window

public static PreferencesFx of(StorageHandler customStorageHandler, Category... categories)

Creates the Preferences window.

Parameters

customStorageHandler:StorageHandler: Custom implementation of the StorageHandler
categories:Category[]: the items to be displayed in the TreeSearchView

Returns:PreferencesFx

the preferences window

persistApplicationState	back to summary
public PreferencesFx persistApplicationState(boolean enable) Defines if the PreferencesAPI should save the applications states. This includes the persistence of the dialog window, as well as each settings values. Parameters enable:boolean if true, the storing of the window state of the dialog window and the settings values are enabled. Returns:PreferencesFx this object for fluent API

persistApplicationState

back to summary

public PreferencesFx persistApplicationState(boolean enable)

Defines if the PreferencesAPI should save the applications states. This includes the persistence of the dialog window, as well as each settings values.

Parameters

enable:boolean: if true, the storing of the window state of the dialog window and the settings values are enabled.

Returns:PreferencesFx

this object for fluent API

persistWindowState	back to summary
public PreferencesFx persistWindowState(boolean persist) Defines whether the state of the dialog window should be persisted or not. Parameters persist:boolean if true, the size, position and last selected item in the TreeSearchView are being saved. When the dialog is showed again, it will be restored to the last saved state. Defaults to false. Returns:PreferencesFx this object for fluent API

persistWindowState

back to summary

public PreferencesFx persistWindowState(boolean persist)

Defines whether the state of the dialog window should be persisted or not.

Parameters

persist:boolean: if true, the size, position and last selected item in the TreeSearchView are being saved. When the dialog is showed again, it will be restored to the last saved state. Defaults to false.

Returns:PreferencesFx

this object for fluent API

removeEventHandler back to summary

removeEventHandler	back to summary
public PreferencesFx removeEventHandler(EventType<PreferencesFxEvent> eventType, EventHandler<? super PreferencesFxEvent> eventHandler) Unregisters a previously registered event handler from the model. 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 Returns:PreferencesFx PreferencesFx to allow for chaining. Exceptions NullPointerException: if either event type or handler are `null`.

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

Unregisters a previously registered event handler from the model. 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

Returns:PreferencesFx

PreferencesFx to allow for chaining.

Exceptions

NullPointerException:: if either event type or handler are null.

saveSettings	back to summary
public PreferencesFx saveSettings(boolean save) Defines whether the adjusted settings of the application should be saved or not. Parameters save:boolean if true, the values of all settings of the application are saved. When the application is started again, the settings values will be restored to the last saved state. Defaults to true. Returns:PreferencesFx this object for fluent API

saveSettings

back to summary

public PreferencesFx saveSettings(boolean save)

Defines whether the adjusted settings of the application should be saved or not.

Parameters

save:boolean: if true, the values of all settings of the application are saved. When the application is started again, the settings values will be restored to the last saved state. Defaults to true.

Returns:PreferencesFx

this object for fluent API

saveSettings	back to summary
public void saveSettings() Call this method to manually save the changed settings when showing the preferences by using `getView()`.

show	back to summary
public void show() Shows the PreferencesFX dialog.

show	back to summary
public void show(boolean modal) Show the PreferencesFX dialog. Parameters modal:boolean window or not modal, that's the question.

show

back to summary

public void show(boolean modal)

Show the PreferencesFX dialog.

Parameters

modal:boolean: window or not modal, that's the question.

public Class PreferencesFx

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail