• Home
• com.dlsc.preferencesfx
• preferencesfx-core
• 11.17.0
• source code
• PreferencesFx.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.dlsc.preferencesfx.PreferencesFx Maven / Gradle / Ivy

package com.dlsc.preferencesfx;

import com.dlsc.formsfx.model.util.TranslationService;
import com.dlsc.preferencesfx.history.History;
import com.dlsc.preferencesfx.model.Category;
import com.dlsc.preferencesfx.model.PreferencesFxModel;
import com.dlsc.preferencesfx.util.SearchHandler;
import com.dlsc.preferencesfx.util.StorageHandler;
import com.dlsc.preferencesfx.util.StorageHandlerImpl;
import com.dlsc.preferencesfx.view.BreadCrumbPresenter;
import com.dlsc.preferencesfx.view.BreadCrumbView;
import com.dlsc.preferencesfx.view.CategoryController;
import com.dlsc.preferencesfx.view.CategoryPresenter;
import com.dlsc.preferencesfx.view.CategoryView;
import com.dlsc.preferencesfx.view.NavigationPresenter;
import com.dlsc.preferencesfx.view.NavigationView;
import com.dlsc.preferencesfx.view.PreferencesFxDialog;
import com.dlsc.preferencesfx.view.PreferencesFxPresenter;
import com.dlsc.preferencesfx.view.PreferencesFxView;
import com.dlsc.preferencesfx.view.UndoRedoBox;
import javafx.collections.ObservableList;
import javafx.event.EventHandler;
import javafx.event.EventType;
import javafx.scene.image.Image;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Represents the main PreferencesFX class.
 *
 * @author François Martin
 * @author Marco Sanfratello
 */
public class PreferencesFx {
  private static final Logger LOGGER =
      LoggerFactory.getLogger(PreferencesFx.class.getName());

  private PreferencesFxModel preferencesFxModel;

  private NavigationView navigationView;
  private NavigationPresenter navigationPresenter;

  private UndoRedoBox undoRedoBox;

  private BreadCrumbView breadCrumbView;
  private BreadCrumbPresenter breadCrumbPresenter;

  private CategoryController categoryController;

  private PreferencesFxView preferencesFxView;
  private PreferencesFxPresenter preferencesFxPresenter;

  private PreferencesFxDialog preferencesFxDialog;

  private PreferencesFx(Class saveClass, Category... categories) {
    this(new StorageHandlerImpl(saveClass), categories);
  }

  private PreferencesFx(StorageHandler storageHandler, Category... categories) {
    // asciidoctor Documentation - tag::testMock[]
    preferencesFxModel = new PreferencesFxModel(
        storageHandler, new SearchHandler(), new History(), categories
    );
    // asciidoctor Documentation - end::testMock[]
    init();
  }

  private void init() {
    // setting values are only loaded if they are present already
    preferencesFxModel.loadSettingValues();

    undoRedoBox = new UndoRedoBox(preferencesFxModel.getHistory());

    breadCrumbView = new BreadCrumbView(preferencesFxModel, undoRedoBox);
    breadCrumbPresenter = new BreadCrumbPresenter(preferencesFxModel, breadCrumbView);

    categoryController = new CategoryController();
    categoryController.setFitToWidth(true);
    initializeCategoryViews();

    // display initial category
    categoryController.setView(preferencesFxModel.getDisplayedCategory());

    navigationView = new NavigationView(preferencesFxModel);
    navigationPresenter = new NavigationPresenter(preferencesFxModel, navigationView);

    preferencesFxView = new PreferencesFxView(
        preferencesFxModel, navigationView, breadCrumbView, categoryController
    );
    preferencesFxPresenter = new PreferencesFxPresenter(preferencesFxModel, preferencesFxView);

    preferencesFxDialog = new PreferencesFxDialog(preferencesFxModel, preferencesFxView);
  }

  /**
   * Creates the Preferences window.
   *
   * @param saveClass  the class which the preferences are saved as Must be unique to the
   *                   application using the preferences
   * @param categories the items to be displayed in the TreeSearchView
   * @return the preferences window
   */
  public static PreferencesFx of(Class saveClass, Category... categories) {
    return new PreferencesFx(saveClass, categories);
  }

  /**
   * Creates the Preferences window.
   *
   * @param customStorageHandler Custom implementation of the {@link StorageHandler}
   * @param categories           the items to be displayed in the TreeSearchView
   * @return the preferences window
   */
  public static PreferencesFx of(StorageHandler customStorageHandler, Category... categories) {
    return new PreferencesFx(customStorageHandler, categories);
  }

  /**
   * Prepares the CategoryController by creating CategoryView / CategoryPresenter pairs from all
   * Categories and loading them into the CategoryController.
   */
  private void initializeCategoryViews() {
    preferencesFxModel.getFlatCategoriesLst().forEach(category -> {
      CategoryView categoryView = new CategoryView(preferencesFxModel, category);
      CategoryPresenter categoryPresenter = new CategoryPresenter(
          preferencesFxModel, category, categoryView, breadCrumbPresenter
      );
      categoryController.addView(category, categoryView, categoryPresenter);
    });
  }

  /**
   * Shows the PreferencesFX dialog.
   */
  public void show() {
    // by default, modal is false for retro-compatibility
    show(false);
  }

  /**
   * Show the PreferencesFX dialog.
   *
   * @param modal window or not modal, that's the question.
   */
  public void show(boolean modal) {
    preferencesFxDialog.show(modal);
  }

  /**
   * Defines if the PreferencesAPI should save the applications states. This includes the
   * persistence of the dialog window, as well as each settings values.
   *
   * @param enable if true, the storing of the window state of the dialog window and the settings
   *               values are enabled.
   * @return this object for fluent API
   */
  public PreferencesFx persistApplicationState(boolean enable) {
    persistWindowState(enable);
    saveSettings(enable);
    return this;
  }

  /**
   * Defines whether the state of the dialog window should be persisted or not.
   *
   * @param persist 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.
   * @return this object for fluent API
   */
  // asciidoctor Documentation - tag::fluentApiMethod[]
  public PreferencesFx persistWindowState(boolean persist) {
    preferencesFxModel.setPersistWindowState(persist);
    return this;
  }
  // asciidoctor Documentation - end::fluentApiMethod[]

  /**
   * Defines whether the adjusted settings of the application should be saved or not.
   *
   * @param save 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.
   * @return this object for fluent API
   */
  public PreferencesFx saveSettings(boolean save) {
    preferencesFxModel.setSaveSettings(save);
    // if settings shouldn't be saved, clear them if there are any present
    if (!save) {
      preferencesFxModel.getStorageHandler().clearPreferences();
    }
    return this;
  }

  /**
   * Call this method to manually save the changed settings when showing the preferences by using
   * {@link #getView()}.
   */
  public void saveSettings() {
    preferencesFxModel.saveSettings();
  }

  /**
   * Call this method to undo all changes made in the settings when showing the preferences by using
   * {@link #getView()}.
   */
  public void discardChanges() {
    preferencesFxModel.discardChanges();
  }

  /**
   * Check if any changes are pending. Useful when manually saving settings.
   * @return true if there are unsaved changed.
   */
  public boolean isContainingChanges() {
    return !preferencesFxModel.getHistory().getChanges().isEmpty();
  }

  /**
   * 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.
   *
   * @param debugState if true, pressing the key combination will open the dialog
   * @return this object for fluent API
   */
  public PreferencesFx debugHistoryMode(boolean debugState) {
    preferencesFxModel.setHistoryDebugState(debugState);
    return this;
  }

  /**
   * Defines whether changes should be instantly persisted or not.
   * When {@code instantPersistent} is false, call {@link #saveSettings()} to apply the changes.
   *
   * @param instantPersistent if true, will instantly persist changes
   * @return this object for fluent API
   */
  public PreferencesFx instantPersistent(boolean instantPersistent) {
    preferencesFxModel.setInstantPersistent(instantPersistent);
    return this;
  }

  public PreferencesFx buttonsVisibility(boolean isVisible) {
    preferencesFxModel.setButtonsVisible(isVisible);
    return this;
  }

  /**
   * Sets the translation service property of the preferences dialog.
   *
   * @param newValue The new value for the translation service property.
   * @return PreferencesFx to allow for chaining.
   */
  public PreferencesFx i18n(TranslationService newValue) {
    preferencesFxModel.setTranslationService(newValue);
    return this;
  }

  /**
   * Registers an event handler with the model. The handler is called when the model receives an
   * {@code Event} of the specified type during the bubbling phase of event delivery.
   *
   * @param eventType    the type of the events to receive by the handler
   * @param eventHandler the handler to register
   * @return PreferencesFx to allow for chaining.
   * @throws NullPointerException if either event type or handler are {@code null}.
   */
  public PreferencesFx addEventHandler(EventType eventType,
                                       EventHandler eventHandler) {
    preferencesFxModel.addEventHandler(eventType, eventHandler);
    return this;
  }

  /**
   * 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.
   *
   * @param eventType    the event type from which to unregister
   * @param eventHandler the handler to unregister
   * @return PreferencesFx to allow for chaining.
   * @throws NullPointerException if either event type or handler are {@code null}.
   */
  public PreferencesFx removeEventHandler(EventType eventType,
                                          EventHandler eventHandler) {
    preferencesFxModel.removeEventHandler(eventType, eventHandler);
    return this;
  }

  /**
   * Returns a PreferencesFxView, so that it can be used as a Node.
   *
   * @return a PreferencesFxView, so that it can be used as a Node.
   */
  public PreferencesFxView getView() {
    return preferencesFxView;
  }

  /**
   * Sets the dialog title.
   *
   * @param title the dialog title
   * @return PreferencesFx to allow for chaining.
   */
  public PreferencesFx dialogTitle(String title) {
    preferencesFxDialog.setDialogTitle(title);
    return this;
  }

  /**
   * Sets the dialog icon.
   *
   * @param image the image to be used as the dialog icon.
   * @return PreferencesFx to allow for chaining.
   */
  public PreferencesFx dialogIcon(Image image) {
    preferencesFxDialog.setDialogIcon(image);
    return this;
  }
  
  /**
   * Return the stylesheets of the PreferenceFxDialog.
   *
   * @return the stylesheets List of the PreferenceFxDialog
   */
  public ObservableList getStylesheets() {
    return preferencesFxDialog.getStylesheets();
  }
}