it.unibo.alchemist.boundary.swingui.tape.impl.JEffectRepresentation Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2010-2022, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */
package it.unibo.alchemist.boundary.swingui.tape.impl;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import it.unibo.alchemist.boundary.swingui.api.GraphicalOutputMonitor;
import it.unibo.alchemist.boundary.swingui.effect.api.Effect;
import org.danilopianini.view.ObjectModFrame;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.swing.JLabel;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.border.LineBorder;
import java.awt.Color;
import java.awt.ItemSelectable;
import java.awt.Point;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.event.MouseAdapter;
import java.util.LinkedList;
import java.util.List;

/**
 * Representation of an {@link Effect}. Useful to let the user interact with an
 * effect (create/edit). Effects are relative to a
 * {@link GraphicalOutputMonitor} instance.
 * 
 * @param 
 *            is the type for the concentration
 */
@Deprecated
@SuppressFBWarnings(value = { "SE_BAD_FIELD", "EI_EXPOSE_REP2" }, justification = "This class is not meant to get serialized")
public final class JEffectRepresentation extends JTapeFeatureStack implements ItemSelectable {

    private static final long serialVersionUID = -6875167656425950159L;
    private static final Logger L = LoggerFactory.getLogger(JEffectRepresentation.class);
    private final Effect effect;
    private final GraphicalOutputMonitor monitor;
    private final JLabel info;
    private final List itemListeners = new LinkedList<>();
    private boolean selected;

    /**
     * Creates a new representation for the effect and monitor in input.
     *
     * @param e
     *            is the {@link Effect} to represent
     * @param main
     *            is the {@link GraphicalOutputMonitor} that will use the effect
     */
    public JEffectRepresentation(final Effect e, final GraphicalOutputMonitor main) {
        super();
        effect = e;
        info = new JLabel();
        this.monitor = main;
        registerFeature(info);
        updateColor();
        final MouseAdapter mouseAdapter = new MouseAdapter() {
            @Override
            public void mouseClicked(final java.awt.event.MouseEvent e) {
                if (!selected && isEnabled()) {
                    setSelected(true);
                    try {
                        final ObjectModFrame mod = new ObjectModFrame(effect);
                        mod.addActionListener(e12 -> {
                            updateColor();
                            monitor.repaint();
                        });
                        final Point p = getLocation();
                        SwingUtilities.convertPointToScreen(p, JEffectRepresentation.this);
                        mod.setLocation(p);
                        mod.setVisible(true);
                    } catch (final IllegalAccessException e1) {
                        L.error("Cannot modify the frame target object", e1);
                    }
                } else {
                    setSelected(false);
                }
            }

            @Override
            public void mouseEntered(final java.awt.event.MouseEvent e) {
                if (!selected && isEnabled()) {
                    setBorder(new LineBorder(Color.CYAN, 2));
                }
            }

            @Override
            public void mouseExited(final java.awt.event.MouseEvent e) {
                if (!selected && isEnabled()) {
                    setBorder(new LineBorder(UIManager.getColor("Panel.background")));
                }
            }
        };
        addMouseListener(mouseAdapter);
        final ItemListener itemListener = e1 -> {
            if (e1.getStateChange() == ItemEvent.SELECTED) {
                setBorder(new LineBorder(Color.BLUE, 2));
            } else if (e1.getStateChange() == ItemEvent.DESELECTED) {
                setBorder(new LineBorder(UIManager.getColor("Panel.background")));
            }

        };
        addItemListener(itemListener);
    }

    private static String getActualClassUpperLetters(final Object o) {
        final StringBuilder sb = new StringBuilder();
        final String name = o.getClass().getSimpleName();
        for (final char c : name.toCharArray()) {
            if (Character.isUpperCase(c)) {
                sb.append(c);
            }
        }
        return sb.toString();
    }

    @Override
    public void addItemListener(final ItemListener l) {
        itemListeners.add(l);
    }

    /**
     * Gets the represented effects.
     * 
     * @return an {@link Effect}
     */
    public Effect getEffect() {
        return effect;
    }

    @Override
    public Object[] getSelectedObjects() {
        if (selected) {
            return new Object[] { this };
        } else {
            return null; // NOPMD: superclass' documentation: "returns the selected items or null if no items are selected"
        }
    }

    /**
     * Check if the representation is selected.
     * 
     * @return a boolean value
     */
    public boolean isSelected() {
        return selected;
    }

    /**
     * (Un)selects this representation.
     *
     * @param s
     *            a boolean
     */
    public void setSelected(final boolean s) {
        selected = s;
        notifySelection();
    }

    private void notifySelection() {
        for (final ItemListener l : itemListeners) {
            l.itemStateChanged(new ItemEvent(this, 0, this, selected ? ItemEvent.SELECTED : ItemEvent.DESELECTED));
        }
    }

    @Override
    public void removeItemListener(final ItemListener l) {
        itemListeners.remove(l);
    }

    @Override
    public void setEnabled(final boolean value) {
        super.setEnabled(value);
        if (!value) {
            selected = false;
        }
    }

    private void updateColor() {
        final Color c = effect.getColorSummary();
        final float brightness = Color.RGBtoHSB(c.getRed(), c.getGreen(), c.getBlue(), null)[2];
        final Color neg = brightness < 0.5f ? Color.WHITE : Color.BLACK;
        setBackground(c);
        info.setForeground(neg);
        info.setText(getActualClassUpperLetters(effect));
    }

}