MapPreviewAccessory.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;
 
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.Image;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.util.prefs.Preferences;
import javax.swing.Action;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JFileChooser;
import javax.swing.JLabel;
import javax.swing.JScrollPane;
import javax.swing.SwingConstants;
import javax.swing.filechooser.FileView;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.gui.mapimagecache.MapImageCache;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import net.sf.japi.swing.action.ToggleAction;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapPreviewAccessory extends JComponent {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private static final Preferences PREFERENCES = Preferences.userNodeForPackage(MainControl.class);
 
    @NotNull
    private static final String PREFERENCES_AUTO_GENERATE_PREVIEW = "autoGeneratePreviews";
 
    @NotNull
    private final MapImageCache<?, ?, ?> mapImageCache;
 
    @NotNull
    private final JLabel preview = new JLabel();
 
    @NotNull
    private final ToggleAction autoGeneratePreview = (ToggleAction) ACTION_BUILDER.createToggle(false, "autoGeneratePreviews", this);
 
    @NotNull
    private final Action genPreview = ACTION_BUILDER.createAction(false, "genPreview", this);
 
    @NotNull
    private final JFileChooser fileChooser;
 
    @NotNull
    private File @Nullable [] selectedFiles;
 
    private boolean autoGeneratePreviews;
 
    public MapPreviewAccessory(@NotNull final MapImageCache<?, ?, ?> mapImageCache, @NotNull final JFileChooser fileChooser) {
        this.mapImageCache = mapImageCache;
        this.fileChooser = fileChooser;
        buildUI();
        setPreview("genPreviewNone.text");
 
        final PropertyChangeListener propertyChangeListener = evt -> {
            final String prop = evt.getPropertyName();
            if (JFileChooser.DIRECTORY_CHANGED_PROPERTY.equals(prop)) {
                setPreview("genPreviewNone.text");
            } else if (JFileChooser.SELECTED_FILE_CHANGED_PROPERTY.equals(prop)) {
                final File selectedFile = (File) evt.getNewValue();
                if (selectedFile == null) {
                    setPreview("genPreviewNone.text");
                } else {
                    final Image previewImage = getMapPreview(selectedFile);
                    if (previewImage == null) {
                        setPreview("genPreviewNone.text");
                    } else {
                        setPreview(previewImage);
                    }
                }
            } else if (JFileChooser.SELECTED_FILES_CHANGED_PROPERTY.equals(prop)) {
                selectedFiles = (File[]) evt.getNewValue();
            }
        };
        fileChooser.addPropertyChangeListener(propertyChangeListener);
        fileChooser.setFileView(new MapFileView());
    }
 
    private void buildUI() {
        setAutoGeneratePreviews(PREFERENCES.getBoolean(PREFERENCES_AUTO_GENERATE_PREVIEW, false));
        setPreferredSize(new Dimension(240, 115));
        setLayout(new BorderLayout());
        add(autoGeneratePreview.createCheckBox(), BorderLayout.NORTH);
        add(new JButton(genPreview), BorderLayout.SOUTH);
        preview.setHorizontalAlignment(SwingConstants.CENTER);
        add(new JScrollPane(preview), BorderLayout.CENTER);
    }
 
    private void setPreview(@Nullable final Image image) {
        preview.setIcon(image == null ? null : new ImageIcon(image));
        preview.setText(null);
    }
 
    private void setPreview(@NotNull final String text) {
        preview.setIcon(null);
        preview.setText(ACTION_BUILDER.getString(text));
    }
 
    @ActionMethod
    public void setAutoGeneratePreviews(final boolean autoGeneratePreviews) {
        this.autoGeneratePreviews = autoGeneratePreviews;
        autoGeneratePreview.setSelected(autoGeneratePreviews);
        PREFERENCES.putBoolean(PREFERENCES_AUTO_GENERATE_PREVIEW, autoGeneratePreviews);
        if (autoGeneratePreviews) {
            fileChooser.validate();
            fileChooser.repaint();
        }
    }
 
    @ActionMethod
    public boolean isAutoGeneratePreviews() {
        return autoGeneratePreviews;
    }
 
    @ActionMethod
    public void genPreview() {
        final File[] files = selectedFiles;
        if (files == null || files.length == 0) {
            return;
        }
 
        for (final File file : files) {
            mapImageCache.flush(file);
 
            final Image image = mapImageCache.getOrCreatePreview(file);
            setPreview(image);
        }
        fileChooser.validate();
        fileChooser.repaint();
    }
 
    @Nullable
    private Image getMapIcon(@NotNull final File mapFile) {
        return autoGeneratePreview.isSelected() ? mapImageCache.getOrCreateIcon(mapFile) : mapImageCache.getIcon(mapFile);
    }
 
    @Nullable
    private Image getMapPreview(@NotNull final File mapFile) {
        return autoGeneratePreview.isSelected() ? mapImageCache.getOrCreatePreview(mapFile) : mapImageCache.getPreview(mapFile);
    }
 
    private class MapFileView extends FileView {
 
        @Override
        public Icon getIcon(@NotNull final File f) {
            final Image image = fileChooser.getCurrentDirectory().equals(f.getParentFile()) ? getMapIcon(f) : null;
            return image == null ? super.getIcon(f) : new ImageIcon(image);
        }
 
    }
 
}