DefaultMapView.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 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.map.mapview;
 
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Point;
import java.beans.PropertyVetoException;
import java.util.Set;
import javax.swing.Action;
import javax.swing.JComponent;
import javax.swing.JInternalFrame;
import javax.swing.JScrollPane;
import javax.swing.KeyStroke;
import javax.swing.WindowConstants;
import net.sf.gridarta.gui.map.renderer.AbstractMapRenderer;
import net.sf.gridarta.gui.map.renderer.MapRenderer;
import net.sf.gridarta.gui.utils.MenuUtils;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.direction.Direction;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.io.PathManager;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.maparchobject.MapArchObjectListener;
import net.sf.gridarta.model.mapcontrol.MapControl;
import net.sf.gridarta.model.mapcontrol.MapControlListener;
import net.sf.gridarta.model.mapcursor.MapCursor;
import net.sf.gridarta.model.mapgrid.MapGrid;
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.validation.ErrorCollector;
import net.sf.gridarta.utils.ActionUtils;
import net.sf.gridarta.utils.Size2D;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class DefaultMapView<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractMapView<G, A, R> {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(DefaultMapView.class);
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final MapControl<G, A, R> mapControl;
 
    @NotNull
    private final JInternalFrame internalFrame;
 
    private final int number;
 
    @NotNull
    private final PathManager pathManager;
 
    @NotNull
    private final AbstractMapRenderer<G, A, R> renderer;
 
    @NotNull
    private final ErroneousMapSquares<G, A, R> erroneousMapSquares;
 
    @NotNull
    private final MapCursorTracker<G, A, R> mapCursorTracker;
 
    @NotNull
    private final MapModelListener<G, A, R> mapModelListener = new MapModelListener<G, A, R>() {
 
        @Override
        public void mapSizeChanged(@NotNull final Size2D newSize) {
            // ignore
        }
 
        @Override
        public void mapSquaresChanged(@NotNull final Set<MapSquare<G, A, R>> mapSquares) {
            // ignore
        }
 
        @Override
        public void mapObjectsChanged(@NotNull final Set<G> gameObjects, @NotNull final Set<G> transientGameObjects) {
            // ignore
        }
 
        @Override
        public void errorsChanged(@NotNull final ErrorCollector<G, A, R> errors) {
            // ignore
        }
 
        @Override
        public void mapFileChanged(@Nullable final MapFile oldMapFile) {
            updateTitle();
        }
 
        @Override
        public void modifiedChanged() {
            updateTitle();
        }
 
    };
 
    @NotNull
    private final MapArchObjectListener mapArchObjectListener = new MapArchObjectListener() {
 
        @Override
        public void mapMetaChanged() {
            updateTitle();
        }
 
        @Override
        public void mapSizeChanged(@NotNull final Size2D mapSize) {
            // ignore
        }
 
    };
 
    @NotNull
    private final MapControlListener<G, A, R> mapControlListener = mapControl -> updateTitle();
 
    public DefaultMapView(@NotNull final MapControl<G, A, R> mapControl, final int number, @NotNull final PathManager pathManager, @NotNull final MapGrid mapGrid, @NotNull final MapCursor<G, A, R> mapCursor, @NotNull final AbstractMapRenderer<G, A, R> renderer, final int xScrollDistance, final int yScrollDistance) {
        super(mapControl.getMapModel(), mapGrid, mapCursor);
        internalFrame = new JInternalFrame(getWindowTitle(mapControl, number, pathManager), true, true, true, true);
        this.mapControl = mapControl;
        this.number = number;
        this.pathManager = pathManager;
        this.renderer = renderer;
        final MapModel<G, A, R> mapModel = mapControl.getMapModel();
        erroneousMapSquares = new ErroneousMapSquares<>(mapModel, mapGrid, renderer);
        mapCursorTracker = new MapCursorTracker<>(mapControl.isPickmap(), xScrollDistance, yScrollDistance, mapCursor, renderer);
        mapModel.addMapModelListener(mapModelListener);
        mapModel.getMapArchObject().addMapArchObjectListener(mapArchObjectListener);
        mapControl.addMapControlListener(mapControlListener);
        internalFrame.getContentPane().setLayout(new BorderLayout());
        internalFrame.getContentPane().add(mapCursorTracker.getScrollPane(), BorderLayout.CENTER);
        internalFrame.setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);
        internalFrame.setAutoscrolls(true);
        internalFrame.setFocusable(true);
        for (final Direction direction : Direction.values()) {
            installAccelerator("moveCursor" + direction.getId());
        }
        installAccelerator("moveSquarePrev");
        installAccelerator("moveSquareNext");
        installAccelerator("moveSquareUp");
        installAccelerator("moveSquareDown");
        installAccelerator("moveSquareInv");
        installAccelerator("moveSquareEnv");
    }
 
    @Override
    public void setViewPosition(@NotNull final Point viewPosition) {
        mapCursorTracker.setViewPosition(viewPosition);
    }
 
    private void installAccelerator(@NotNull final String key) {
        final Action action = ACTION_BUILDER.getAction(key);
        if (action != null) {
            final KeyStroke keyStroke1 = ActionUtils.getShortcut(action);
            if (keyStroke1 != null) {
                internalFrame.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(keyStroke1, key);
            }
            final KeyStroke keyStroke2 = ActionUtils.getAlternativeShortcut(action);
            if (keyStroke2 != null) {
                internalFrame.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(keyStroke2, key);
            }
            internalFrame.getActionMap().put(key, action);
        }
    }
 
    @Override
    public void closeNotify() {
        super.closeNotify();
        internalFrame.getContentPane().remove(mapCursorTracker.getScrollPane());
        mapCursorTracker.closeNotify();
        erroneousMapSquares.closeNotify();
        renderer.closeNotify();
        mapControl.removeMapControlListener(mapControlListener);
        final MapModel<G, A, R> mapModel = mapControl.getMapModel();
        mapModel.getMapArchObject().removeMapArchObjectListener(mapArchObjectListener);
        mapModel.removeMapModelListener(mapModelListener);
        //mapFileActions.closeNotify();
        MenuUtils.disposeMenuElement(internalFrame.getJMenuBar());
    }
 
    private void updateTitle() {
        internalFrame.setTitle(getWindowTitle());
    }
 
    @NotNull
    @Override
    public String getWindowTitle() {
        return getWindowTitle(mapControl, number, pathManager);
    }
 
    @NotNull
    private static String getWindowTitle(@NotNull final MapControl<?, ?, ?> mapControl, final int number, @NotNull final PathManager pathManager) {
        final MapFile mapFile = mapControl.getMapModel().getMapFile();
        final String mapPath = mapFile == null ? "<unsaved>" : mapFile.getMapPath().toString();
        return mapPath + " [ " + mapControl.getMapModel().getMapArchObject().getMapName() + " ] (" + number + ")" + (mapControl.getMapModel().isModified() ? " *" : "");
    }
 
    @NotNull
    @Override
    public Component getComponent() {
        return internalFrame;
    }
 
    @NotNull
    @Override
    public MapControl<G, A, R> getMapControl() {
        return mapControl;
    }
 
    @Override
    public void activate() {
        try {
            internalFrame.setSelected(true);
        } catch (final PropertyVetoException e) {
            LOG.warn("Unexpected exception", e);
        }
        internalFrame.setVisible(true);
        internalFrame.requestFocus();
        internalFrame.restoreSubcomponentFocus();
    }
 
    @NotNull
    @Override
    public JInternalFrame getInternalFrame() {
        return internalFrame;
    }
 
    @NotNull
    @Override
    public MapRenderer getRenderer() {
        return renderer;
    }
 
    @NotNull
    @Override
    public JScrollPane getScrollPane() {
        return mapCursorTracker.getScrollPane();
    }
 
}