com.dlsc.preferencesfx.model.Group 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.model;

import com.dlsc.formsfx.model.structure.DataField;
import com.dlsc.formsfx.model.structure.Element;
import com.dlsc.preferencesfx.formsfx.view.controls.SimpleControl;
import com.dlsc.preferencesfx.formsfx.view.renderer.PreferencesFxGroup;
import com.dlsc.preferencesfx.util.Constants;
import com.dlsc.preferencesfx.util.VisibilityProperty;
import java.util.Arrays;
import java.util.List;
import javafx.beans.property.SimpleStringProperty;
import javafx.beans.property.StringProperty;
import javafx.event.EventHandler;
import javafx.scene.input.MouseEvent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Represents a group, which is used to structure one to multiple settings in a category.
 *
 * @author François Martin
 * @author Marco Sanfratello
 */
public class Group {

  private static final Logger LOGGER =
      LoggerFactory.getLogger(Group.class.getName());

  private static final String MARKED_STYLE_CLASS = "group-marked";
  private String description;
  private List settings;
  private PreferencesFxGroup preferencesGroup;
  private boolean marked = false;
  private final EventHandler unmarker = event -> unmark();
  private final StringProperty breadcrumb = new SimpleStringProperty("");

  private VisibilityProperty visibilityProperty;

  private Group(String description, VisibilityProperty visibilityProperty, Setting... settings) {
    this.description = description;
    this.settings = Arrays.asList(settings);
    this.visibilityProperty = visibilityProperty;
  }

  /**
   * Constructs a new group with a {@code description} and {@code settings}.
   *
   * @param description the title of this group
   * @param settings    the settings that belong to this group
   * @return this object for chaining with the fluent API
   */
  public static Group of(String description, Setting... settings) {
    return new Group(description, null, settings);
  }

  public static Group of(String description, VisibilityProperty visibilityProperty, Setting... settings) {
    Group group = new Group(description, visibilityProperty, settings);

    group.applyVisibilityForSettings();

    return group;
  }

  /**
   * Constructs a new group with {@code settings}, without a {@code description}.
   *
   * @param settings the settings that belong to this group
   * @return this object for chaining with the fluent API
   */
  public static Group of(Setting... settings) {
    return new Group(null, null, settings);
  }

  /**
   * Constructs a new group with {@code settings}, without a {@code description}.
   *
   * @param settings the settings that belong to this group
   * @param visibilityProperty visibility condition for Group
   * @return this object for chaining with the fluent API
   */
  public static Group of(VisibilityProperty visibilityProperty, Setting... settings) {
    Group group = new Group(null, visibilityProperty, settings);

    group.applyVisibilityForSettings();

    return group;
  }

  /**
   * Sets a {@code description} for this group.
   *
   * @param description the title of this group
   * @return this object for chaining with the fluent API
   */
  public Group description(String description) {
    this.description = description;
    return this;
  }

  /**
   * Returns the description of this group or if i18n is used, it will return the translated
   * description in the current locale.
   *
   * @return the description
   */
  public String getDescription() {
    if (preferencesGroup != null) {
      return preferencesGroup.getTitle();
    }
    return description;
  }

  public List getSettings() {
    return settings;
  }

  public PreferencesFxGroup getPreferencesGroup() {
    return preferencesGroup;
  }

  public void setPreferencesGroup(PreferencesFxGroup preferencesGroup) {
    this.preferencesGroup = preferencesGroup;
  }

  /**
   * Marks this group in the GUI.
   * Is used for the search, which marks and unmarks items depending on the match as a form of
   * visual feedback.
   */
  public void mark() {
    // ensure it's not marked yet - so a control doesn't contain the same styleClass multiple times
    if (!marked) {
      preferencesGroup.getRenderer().addStyleClass(MARKED_STYLE_CLASS);
      preferencesGroup.getRenderer().getTitleLabel().setOnMouseExited(unmarker);
      marked = !marked;
    }
  }

  /**
   * Unmarks this group in the GUI.
   * Is used for the search, which marks and unmarks items depending on the match as a form of
   * visual feedback.
   */
  public void unmark() {
    // check if it's marked before removing the style class
    if (marked) {
      preferencesGroup.getRenderer().removeStyleClass(MARKED_STYLE_CLASS);
      preferencesGroup.getRenderer().getTitleLabel().removeEventHandler(
          MouseEvent.MOUSE_EXITED, unmarker
      );
      marked = !marked;
    }
  }

  /**
   * Adds the {@code breadCrumb} to this breadcrumb and updates all of its settings accordingly.
   *
   * @param breadCrumb the breadcrumb to add to this group's breadcrumb
   */
  public void addToBreadcrumb(String breadCrumb) {
    setBreadcrumb(breadCrumb + Constants.BREADCRUMB_DELIMITER + description);
    settings.forEach(setting -> setting.addToBreadcrumb(getBreadcrumb()));
  }

  public String getBreadcrumb() {
    return breadcrumb.get();
  }

  public StringProperty breadcrumbProperty() {
    return breadcrumb;
  }

  public void setBreadcrumb(String breadcrumb) {
    this.breadcrumb.set(breadcrumb);
  }

  public VisibilityProperty getVisibilityProperty() {
    return visibilityProperty;
  }

  public void setVisibilityProperty(VisibilityProperty visibilityProperty) {
    this.visibilityProperty = visibilityProperty;
  }

  private void applyVisibilityForSettings() {
    if (settings != null) {
      for (Setting setting : settings) {
        setting.applyVisibility(visibilityProperty, true);
      }
    }
  }
}