SelectedSquareView.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 The Gridarta Developers.
 *
 * 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 2 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package net.sf.gridarta.gui.panel.selectedsquare;

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Container;
import java.awt.FlowLayout;
import java.awt.GridLayout;
import java.awt.Insets;
import java.awt.Point;
import java.awt.event.InputEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.geom.RectangularShape;
import java.util.Set;
import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.DefaultListModel;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JViewport;
import javax.swing.ListSelectionModel;
import javax.swing.ScrollPaneConstants;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import net.sf.gridarta.gui.dialog.gameobjectattributes.GameObjectAttributesDialogFactory;
import net.sf.gridarta.gui.map.mapview.MapView;
import net.sf.gridarta.gui.map.mapview.MapViewManager;
import net.sf.gridarta.gui.map.mapview.MapViewManagerListener;
import net.sf.gridarta.gui.panel.objectchooser.ObjectChooser;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.baseobject.BaseObject;
import net.sf.gridarta.model.face.FaceObjectProviders;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.mapcursor.MapCursor;
import net.sf.gridarta.model.mapcursor.MapCursorListener;
import net.sf.gridarta.model.mapmodel.MapFile;
import net.sf.gridarta.model.mapmodel.MapModel;
import net.sf.gridarta.model.mapmodel.MapModelListener;
import net.sf.gridarta.model.mapmodel.MapSquare;
import net.sf.gridarta.model.mapviewsettings.MapViewSettings;
import net.sf.gridarta.model.validation.ErrorCollector;
import net.sf.gridarta.utils.Size2D;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class SelectedSquareView<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends JPanel {

    private static final long serialVersionUID = 1L;

    @NotNull
    private final SelectedSquareModel<G, A, R> selectedSquareModel;

    @NotNull
    private final ModelUpdater<G, A, R> modelUpdater;

    @NotNull
    private final GameObjectAttributesDialogFactory<G, A, R> gameObjectAttributesDialogFactory;

    @NotNull
    private final ObjectChooser<G, A, R> objectChooser;

    @NotNull
    private final MapViewSettings mapViewSettings;

    @NotNull
    private final DefaultListModel<G> model = new DefaultListModel<>();

    @NotNull
    private final JList<G> list = new JList<>(model);

    @NotNull
    private final Container arrows = new JPanel();

    @Nullable
    private MapModel<G, A, R> mapModel;

    @Nullable
    private MapCursor<G, A, R> mapCursor;

    @NotNull
    private final MapModelListener<G, A, R> mapModelListener = new MapModelListener<G, A, R>() {

        @Override
        public void mapSizeChanged(@NotNull final Size2D newSize) {
            refresh();
        }

        @Override
        public void mapSquaresChanged(@NotNull final Set<MapSquare<G, A, R>> mapSquares) {
            if (selectedSquareModel.isSelectedMapSquares(mapSquares)) {
                refresh();
            }
        }

        @Override
        public void mapObjectsChanged(@NotNull final Set<G> gameObjects, @NotNull final Set<G> transientGameObjects) {
            if (selectedSquareModel.isSelectedGameObjects(gameObjects) || selectedSquareModel.isSelectedGameObjects(transientGameObjects)) {
                refresh();
            }
        }

        @Override
        public void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
            // ignore
        }

        @Override
        public void mapFileChanged(@Nullable final MapFile oldMapFile) {
            // ignore
        }

        @Override
        public void modifiedChanged() {
            // ignore
        }

    };

    @NotNull
    private final MapViewManagerListener<G, A, R> mapViewManagerListener = new MapViewManagerListener<G, A, R>() {

        @Override
        public void activeMapViewChanged(@Nullable final MapView<G, A, R> mapView) {
            @Nullable final MapModel<G, A, R> mapModel;
            @Nullable final MapCursor<G, A, R> mapCursor;
            if (mapView == null) {
                mapModel = null;
                mapCursor = null;
            } else {
                mapModel = mapView.getMapControl().getMapModel();
                mapCursor = mapView.getMapCursor();
            }
            setMapCursor(mapModel, mapCursor);
        }

        @Override
        public void mapViewCreated(@NotNull final MapView<G, A, R> mapView) {
            // ignore
        }

        @Override
        public void mapViewClosing(@NotNull final MapView<G, A, R> mapView) {
            // ignore
        }

    };

    @NotNull
    private final SelectedSquareModelListener<G, A, R> selectedSquareModelListener = new SelectedSquareModelListener<G, A, R>() {

        @Override
        public void selectionChanged(@Nullable final MapSquare<G, A, R> mapSquare, @Nullable final G gameObject) {
            refresh();
        }

    };

    @NotNull
    private final ListSelectionListener listSelectionListener = new ListSelectionListener() {

        @Override
        public void valueChanged(final ListSelectionEvent e) {
            setSelectedIndex(list.getSelectedIndex());
        }

    };

    @NotNull
    private final MapCursorListener<G, A, R> mapCursorListener = new MapCursorListener<G, A, R>() {

        @Override
        public void mapCursorChangedPos(@NotNull final Point location) {
            // ignore
        }

        @Override
        public void mapCursorChangedMode() {
            // ignore
        }

        @Override
        public void mapCursorChangedGameObject(@Nullable final MapSquare<G, A, R> mapSquare, @Nullable final G gameObject) {
            if (selectedSquareModel.setSelectedMapSquare(mapSquare, gameObject)) {
                refresh();
            }
        }

        @Override
        public void mapCursorChangedSize() {
            // ignore
        }

    };

    @NotNull
    private final MouseListener mouseListener = new MouseAdapter() {

        @Override
        public void mousePressed(final MouseEvent e) {
            if (isSelect(e)) {
                if (e.getClickCount() > 1) { // LMB Double click
                    final G gameObject = selectedSquareModel.getSelectedGameObject();
                    if (gameObject != null) {
                        gameObjectAttributesDialogFactory.showAttributeDialog(gameObject);
                    }
                }
            } else if (isInsert(e)) {
                insertGameObject(getListIndex(e));
            } else if (isDelete(e)) {
                deleteGameObject(getListIndex(e));
            }
        }

    };

    public SelectedSquareView(@NotNull final SelectedSquareModel<G, A, R> selectedSquareModel, @NotNull final GameObjectAttributesDialogFactory<G, A, R> gameObjectAttributesDialogFactory, @NotNull final ObjectChooser<G, A, R> objectChooser, @NotNull final MapViewManager<G, A, R> mapViewManager, @NotNull final MapViewSettings mapViewSettings, @Nullable final ImageIcon compassIcon, @NotNull final FaceObjectProviders faceObjectProviders, @NotNull final Icon unknownSquareIcon, @NotNull final Action... actions) {
        this.selectedSquareModel = selectedSquareModel;
        this.gameObjectAttributesDialogFactory = gameObjectAttributesDialogFactory;
        this.objectChooser = objectChooser;
        this.mapViewSettings = mapViewSettings;

        setLayout(new BorderLayout());

        modelUpdater = new ModelUpdater<>(model, mapViewSettings);
        list.setCellRenderer(new CellRenderer<G, A, R>(faceObjectProviders, unknownSquareIcon));
        list.setBackground(Color.lightGray);
        list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
        final JScrollPane scrollPane = new JScrollPane(list);
        scrollPane.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
        scrollPane.getViewport().setScrollMode(JViewport.SIMPLE_SCROLL_MODE);
        add(scrollPane, BorderLayout.CENTER);

        for (final Action tmpAction : actions) {
            final AbstractButton button = new JButton(tmpAction);
            button.setMargin(new Insets(0, 0, 0, 0));
            arrows.add(button);
        }

        updateArrows(false);
        if (compassIcon != null) {
            final Container compass = new JPanel();
            compass.add(new JLabel(compassIcon));
            add(compass, BorderLayout.NORTH);
        }
        list.addListSelectionListener(listSelectionListener);
        list.addMouseListener(mouseListener);
        list.setFocusable(false); // XXX Workaround for Mantis #0000154 This is not clean and should be removed as soon as cut/copy/paste of arches is possible

        mapViewManager.addMapViewManagerListener(mapViewManagerListener);
        selectedSquareModel.addSelectedSquareListener(selectedSquareModelListener);

        refresh();
    }

    private void updateArrows(final boolean mapSquareListBottom) {
        if (mapSquareListBottom) {
            arrows.setLayout(new GridLayout(4, 1));
            add(arrows, BorderLayout.WEST);  // put up/down buttons west
        } else {
            arrows.setLayout(new FlowLayout());
            add(arrows, BorderLayout.SOUTH); // put up/down buttons south
        }
    }

    public int getListIndex(@NotNull final MouseEvent e) {
        final int lastIndex = model.getSize() - 1;
        if (lastIndex < 0) {
            return 0;
        }

        final RectangularShape bounds = list.getCellBounds(lastIndex, lastIndex);
        final int lowestY = (int) (bounds.getY() + bounds.getHeight());
        if ((int) e.getPoint().getY() >= lowestY) {
            return lastIndex + 1;
        }

        final int listIndex = list.locationToIndex(e.getPoint());
        assert listIndex >= 0; // -1 is returned only if the list is empty, but this was already checked
        return listIndex;
    }

    private void refresh() {
        list.setEnabled(false);
        try {
            setSelectedIndex(modelUpdater.update(selectedSquareModel.getSelectedMapSquare(), selectedSquareModel.getSelectedGameObject()));
        } finally {
            list.setEnabled(true);
        }
    }

    @Nullable
    @SuppressWarnings("TypeMayBeWeakened")
    private G getListGameObject(final int index) {
        final int actualIndex = getValidIndex(index);
        if (actualIndex >= model.getSize()) {
            return null;
        }

        return model.getElementAt(actualIndex);
    }

    private void setSelectedIndex(final int index) {
        final int actualIndex = getValidIndex(index);
        if (list.getSelectedIndex() != actualIndex) {
            list.setSelectedIndex(actualIndex);
        }

        if (mapCursor != null) {
            mapCursor.setGameObject(list.getSelectedValue());
        }
    }

    private int getValidIndex(final int index) {
        if (index < 0) {
            return 0;
        }
        final int size = model.getSize();
        if (index >= size) {
            return Math.max(0, size - 1);
        }
        return index;
    }

    private void deleteGameObject(final int index) {
        final MapCursor<G, A, R> mapCursor = this.mapCursor;
        if (mapCursor != null && index < model.getSize()) {
            setSelectedIndex(index);
            mapCursor.deleteSelectedGameObject(true, mapViewSettings.isAutojoin());
        }
    }

    private void insertGameObject(final int index) {
        final BaseObject<G, A, R, ?> gameObject = objectChooser.getSelection();
        if (gameObject != null) {
            final MapCursor<G, A, R> mapCursor = this.mapCursor;
            if (mapCursor != null) {
                mapCursor.insertGameObject(true, gameObject, index >= model.getSize(), mapViewSettings.isAutojoin());
            }
        }
        setSelectedIndex(index);
    }

    private static boolean isSelect(@NotNull final InputEvent e) {
        return (e.getModifiers() & InputEvent.BUTTON1_MASK) != 0;
    }

    private static boolean isInsert(@NotNull final InputEvent e) {
        return (e.getModifiers() & (InputEvent.BUTTON3_MASK | InputEvent.CTRL_MASK)) == InputEvent.BUTTON3_MASK;
    }

    private static boolean isDelete(@NotNull final InputEvent e) {
        return (e.getModifiers() & InputEvent.BUTTON2_MASK) != 0 || (e.getModifiers() & (InputEvent.BUTTON3_MASK | InputEvent.CTRL_MASK)) == (InputEvent.BUTTON3_MASK | InputEvent.CTRL_MASK);
    }

    private void setMapCursor(@Nullable final MapModel<G, A, R> mapModel, @Nullable final MapCursor<G, A, R> mapCursor) {
        if (this.mapModel != null) {
            this.mapModel.removeMapModelListener(mapModelListener);
        }
        this.mapModel = mapModel;
        if (this.mapModel != null) {
            this.mapModel.addMapModelListener(mapModelListener);
        }

        if (this.mapCursor != null) {
            this.mapCursor.removeMapCursorListener(mapCursorListener);
        }
        this.mapCursor = mapCursor;
        if (this.mapCursor != null) {
            this.mapCursor.addMapCursorListener(mapCursorListener);
        }

        final G gameObject = mapCursor == null ? null : mapCursor.getGameObject();
        final MapSquare<G, A, R> mapSquare = gameObject == null ? null : gameObject.getMapSquare();
        if (selectedSquareModel.setSelectedMapSquare(mapSquare, gameObject)) {
            refresh();
        }
    }

}