MapFolderTreeActions.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.mapfiles;
 
import javax.swing.Action;
import javax.swing.JCheckBoxMenuItem;
import javax.swing.JMenu;
import net.sf.gridarta.gui.dialog.newmap.NewMapDialogFactory;
import net.sf.gridarta.gui.utils.MenuUtils;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.pickmapsettings.PickmapSettings;
import net.sf.gridarta.model.pickmapsettings.PickmapSettingsListener;
import net.sf.gridarta.utils.EditorAction;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapFolderTreeActions<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction {
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final MapFolderTree<G, A, R> mapFolderTree;
 
    @NotNull
    private final PickmapSettings pickmapSettings;
 
    @NotNull
    private final NewMapDialogFactory<G, A, R> newMapDialogFactory;
 
    @NotNull
    private final String createFolderKey;
 
    @NotNull
    private final String deleteFolderKey;
 
    @NotNull
    private final String confirmDeleteFolderKey;
 
    @NotNull
    private final String deleteFolderNotEmptyKey;
 
    @Nullable
    private JMenu folderMenu;
 
    @Nullable
    private MapFolder<G, A, R> activeMapFolder;
 
    @Nullable
    private Action aCreateFolderAction;
 
    @Nullable
    private Action aDeletePickmapFolder;
 
    @NotNull
    private final MapFolderTreeListener<G, A, R> mapFolderTreeListener = new MapFolderTreeListener<G, A, R>() {
 
        @Override
        public void activeMapFolderChanged(@Nullable final MapFolder<G, A, R> mapFolder) {
            activeMapFolder = mapFolder;
            refresh();
        }
 
        @Override
        public void folderAdded(@NotNull final MapFolder<G, A, R> mapFolder) {
            refresh();
        }
 
        @Override
        public void folderRemoved(@NotNull final MapFolder<G, A, R> mapFolder) {
            refresh();
        }
 
    };
 
    @NotNull
    private final PickmapSettingsListener pickmapSettingsListener = locked -> refresh();
 
    public MapFolderTreeActions(@NotNull final MapFolderTree<G, A, R> mapFolderTree, @NotNull final PickmapSettings pickmapSettings, @NotNull final NewMapDialogFactory<G, A, R> newMapDialogFactory, @NotNull final String createFolderKey, @NotNull final String deleteFolderKey, @NotNull final String confirmDeleteFolderKey, @NotNull final String deleteFolderNotEmptyKey) {
        this.mapFolderTree = mapFolderTree;
        this.pickmapSettings = pickmapSettings;
        this.newMapDialogFactory = newMapDialogFactory;
        this.createFolderKey = createFolderKey;
        this.deleteFolderKey = deleteFolderKey;
        this.confirmDeleteFolderKey = confirmDeleteFolderKey;
        this.deleteFolderNotEmptyKey = deleteFolderNotEmptyKey;
        mapFolderTree.addModelListener(mapFolderTreeListener);
        activeMapFolder = mapFolderTree.getActiveMapFolder();
        pickmapSettings.addPickmapSettingsListener(pickmapSettingsListener);
        refresh();
    }
 
    @Deprecated
    public void setPickmapFoldersMenu(@Nullable final JMenu folderMenu) {
        this.folderMenu = folderMenu;
        refresh();
    }
 
    private void refresh() {
        if (aCreateFolderAction != null) {
            aCreateFolderAction.setEnabled(doCreateFolder(false));
        }
        if (aDeletePickmapFolder != null) {
            aDeletePickmapFolder.setEnabled(doDeletePickmapFolder(false));
        }
 
        if (folderMenu == null) {
            return;
        }
 
        MenuUtils.removeAll(folderMenu);
        for (final MapFolder<G, A, R> mapFolder : mapFolderTree) {
            final JCheckBoxMenuItem menuItem = new JCheckBoxMenuItem();
            final Action action = new MapFolderTreeAction<>(mapFolderTree, mapFolder, menuItem);
            menuItem.setAction(action);
            menuItem.setSelected(mapFolder == activeMapFolder);
            assert folderMenu != null;
            folderMenu.add(menuItem);
        }
    }
 
    @ActionMethod
    public void createPickmapFolder() {
        doCreateFolder(true);
    }
 
    private boolean doCreateFolder(final boolean performAction) {
        if (pickmapSettings.isLocked()) {
            return false;
        }
 
        if (performAction) {
            newMapDialogFactory.showNewPickmapFolderDialog(mapFolderTree, activeMapFolder);
        }
 
        return true;
    }
 
    @ActionMethod
    public void deletePickmapFolder() {
        doDeletePickmapFolder(true);
    }
 
    private boolean doDeletePickmapFolder(final boolean performAction) {
        if (pickmapSettings.isLocked()) {
            return false;
        }
 
        final MapFolder<G, A, R> mapFolder = activeMapFolder;
        if (mapFolder == null || mapFolder.getParent() == null) {
            return false;
        }
 
        if (performAction) {
            if (mapFolder.getPickmaps() > 0 && !ACTION_BUILDER.showQuestionDialog(null/*XXX:parent*/, confirmDeleteFolderKey, mapFolder.getName(), mapFolder.getPickmaps())) {
                return false;
            }
 
            try {
                mapFolderTree.removeMapFolder(mapFolder, true);
            } catch (final MapFolderNotEmptyException ex) {
                ACTION_BUILDER.showMessageDialog(null/*XXX:parent*/, deleteFolderNotEmptyKey, mapFolder.getName());
            }
        }
 
        return true;
    }
 
    @Override
    public void setAction(@NotNull final Action action, @NotNull final String name) {
        if (name.equals(createFolderKey)) {
            aCreateFolderAction = action;
        } else if (name.equals(deleteFolderKey)) {
            aDeletePickmapFolder = action;
        } else {
            throw new IllegalArgumentException("unsupported action name: " + name);
        }
        refresh();
    }
 
}