io.github.interacto.jfx.interaction.library.MenuItemInteraction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of interacto-javafx Show documentation
The JavaFX implementation of the Interacto library
The newest version!
/*
 * Interacto
 * Copyright (C) 2020 Arnaud Blouin
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package io.github.interacto.jfx.interaction.library;

import io.github.interacto.fsm.FSM;
import io.github.interacto.interaction.InteractionData;
import io.github.interacto.jfx.interaction.JfxInteraction;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import javafx.collections.FXCollections;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import javafx.collections.ObservableSet;
import javafx.collections.SetChangeListener;
import javafx.event.Event;
import javafx.scene.control.MenuItem;

/**
 * A JavaFX interaction that uses a single menu item.
 * @author Arnaud BLOUIN
 */
public abstract class MenuItemInteraction> extends JfxInteraction {
	protected final ObservableSet registeredItems;
	protected List> additionalMenus;

	/**
	 * Creates the interaction.
	 */
	public MenuItemInteraction(final F fsm) {
		super(fsm);
		registeredItems = FXCollections.observableSet();
		additionalMenus = null;

		// Listener to any changes in the list of registered nodes
		registeredItems.addListener((SetChangeListener) change -> {
			if(change.wasAdded()) {
				onMenuItemRegistered(change.getElementAdded());
			}
			if(change.wasRemoved()) {
				onMenuItemUnregistered(change.getElementRemoved());
			}
		});
	}

	public void registerToObservableMenuList(final ObservableList menuItems) {
		if(menuItems != null) {
			if(additionalMenus == null) {
				additionalMenus = new ArrayList<>();
			}
			additionalMenus.add(menuItems);

			menuItems.forEach(menuitem -> onMenuItemRegistered(menuitem));

			// Listener to any changes in the list
			menuItems.addListener((ListChangeListener) change -> {
				while(change.next()) {
					if(change.wasAdded()) {
						change.getAddedSubList().forEach(elt -> onMenuItemRegistered(elt));
					}
					if(change.wasRemoved()) {
						change.getRemoved().forEach(elt -> onMenuItemUnregistered(elt));
					}
				}
			});
		}
	}

	protected void onMenuItemUnregistered(final MenuItem menuItem) {
		// Should be overriden
	}

	protected void onMenuItemRegistered(final MenuItem menuItem) {
		// Should be overriden
	}

	public final void registerToMenuItems(final List widgets) {
		if(widgets != null) {
			registeredItems.addAll(widgets.stream().filter(Objects::nonNull).collect(Collectors.toList()));
		}
	}

	public final void unregisterFromMenuItems(final List widgets) {
		if(widgets != null) {
			registeredItems.removeAll(widgets.stream().filter(Objects::nonNull).collect(Collectors.toList()));
		}
	}
}