com.dlsc.preferencesfx.view.View Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of preferencesfx-core Show documentation

A framework for quickly creating a UI for setting application preferences.

There is a newer version: 2.0.3

package com.dlsc.preferencesfx.view;

import java.util.List;

/**
 * Defines a view of PreferencesFX.
 *
 * @author François Martin
 * @author Marco Sanfratello
 */
public interface View {

  /**
   * Holds a list of stylesheets.
   *
   * @return list of stylesheets.
   */
  List getStylesheets();

  /**
   * Calls all the other methods for easier initialization.
   */
  default void init() {
    initializeSelf();
    initializeParts();
    layoutParts();
    bindFieldsToModel();
  }

  /**
   * Initializes the view.
   */
  default void initializeSelf() {
  }

  /**
   * Initializes all parts of the view.
   */
  void initializeParts();

  /**
   * Defines the layout of all parts in the view.
   */
  void layoutParts();

  /**
   * Binds properties from the model to the view.
   */
  default void bindFieldsToModel() {
  }

  /**
   * Adds the stylesheet files to the getStylesheets method.
   *
   * @param stylesheetFile list of stylesheet files
   */
  default void addStylesheetFiles(String... stylesheetFile) {
    for (String file : stylesheetFile) {
      String stylesheet = getClass().getResource(file).toExternalForm();
      getStylesheets().add(stylesheet);
    }
  }

}