CFTreasureListTree.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.treasurelist;

import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Container;
import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import javax.swing.AbstractButton;
import javax.swing.BorderFactory;
import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JSplitPane;
import javax.swing.JTree;
import javax.swing.JViewport;
import javax.swing.ScrollPaneConstants;
import javax.swing.WindowConstants;
import javax.swing.text.JTextComponent;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.TreeNode;
import javax.swing.tree.TreePath;
import net.sf.gridarta.gui.dialog.help.Help;
import net.sf.gridarta.model.archetypeset.ArchetypeSet;
import net.sf.gridarta.model.face.FaceObjectProviders;
import net.sf.gridarta.model.face.FaceObjectProvidersListener;
import net.sf.gridarta.model.treasurelist.FolderTreasureObj;
import net.sf.gridarta.model.treasurelist.TreasureTree;
import net.sf.gridarta.model.treasurelist.TreasureTreeNode;
import net.sf.gridarta.utils.ResourceIcons;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class CFTreasureListTree extends JTree {

    @NotNull
    public static final String NONE_SYM = "<none>";

    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");

    private static final long serialVersionUID = 1L;

    @NotNull
    private final TreasureTree treasureTree;

    @NotNull
    private final Frame parent;

    @Nullable
    private JDialog frame;

    @NotNull
    private final AbstractButton okButton = new JButton("Select");

    @NotNull
    private final AbstractButton noneButton = new JButton("None");

    @Nullable
    private JTextComponent input;

    public CFTreasureListTree(@NotNull final TreasureTree treasureTree, @NotNull final Frame parent, @NotNull final ArchetypeSet<?, ?, ?> archetypeSet, @NotNull final FaceObjectProviders faceObjectProviders, @NotNull final ResourceIcons resourceIcons) {
        super(treasureTree.getRoot());
        this.treasureTree = treasureTree;
        this.parent = parent;

        final FaceObjectProvidersListener faceObjectProvidersListener = this::repaint;
        faceObjectProviders.addFaceObjectProvidersListener(faceObjectProvidersListener);

        putClientProperty("JTree.lineStyle", "Angled");
        setCellRenderer(new TreasureCellRenderer(archetypeSet, treasureTree.getRoot(), faceObjectProviders, resourceIcons));
    }

    public synchronized void showDialog(@Nullable final JTextComponent input, @NotNull final Component parent) {
        this.input = input;

        final boolean hasBeenDisplayed = frame != null;
        if (frame != null) {
            if (frame.isShowing()) {
                assert frame != null;
                frame.setVisible(false);
            }

            // collapse everything except root
            expandPath(new TreePath(treasureTree.getRoot()));
            for (int i = getRowCount() - 1; i > 0; i--) {
                collapseRow(i);
            }
        } else {
            // open a popup dialog which temporarily disables all other frames
            frame = new JDialog(this.parent, "Treasurelists", false);
            frame.setDefaultCloseOperation(WindowConstants.HIDE_ON_CLOSE);

            setBorder(BorderFactory.createEmptyBorder(5, 10, 5, 5));
            final JScrollPane scrollPane = new JScrollPane(this);
            scrollPane.getViewport().setScrollMode(JViewport.SIMPLE_SCROLL_MODE);
            scrollPane.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED);
            scrollPane.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);

            final JPanel buttonPanel = buildButtonPanel();
            final JSplitPane splitPane = new JSplitPane(JSplitPane.VERTICAL_SPLIT, scrollPane, buttonPanel);
            splitPane.setOneTouchExpandable(false);
            assert frame != null;
            splitPane.setDividerLocation(frame.getHeight() - buttonPanel.getMinimumSize().height - 4);

            splitPane.setDividerSize(4);
            splitPane.setResizeWeight(1.0);

            assert frame != null;
            frame.getContentPane().add(splitPane);

            expandPath(new TreePath(treasureTree.getRoot()));
        }

        okButton.setVisible(input != null);
        noneButton.setVisible(input != null);

        assert frame != null;
        frame.setSize(470, 550);
        assert frame != null;
        frame.setLocationRelativeTo(parent);

        if (input != null) {
            final String listName = input.getText().trim(); // name of pre-selected list
            final DefaultMutableTreeNode treasureNode = treasureTree.get(listName);
            if (treasureNode != null) {
                final DefaultMutableTreeNode[] node = new DefaultMutableTreeNode[2];
                node[0] = treasureTree.getRoot();
                node[1] = treasureNode;
                final TreePath treePath = new TreePath(node);
                expandPath(treePath);
                setSelectionPath(treePath);

                if (!hasBeenDisplayed) {
                    // If this is the first time, the frame has to be packed,
                    // otherwise no scrolling would be possible (see below).
                    assert frame != null;
                    frame.pack();
                    assert frame != null;
                    frame.setSize(470, 550);
                    setSelectionPath(treePath);
                }

                scrollRowToVisible(getRowCount() - 1);
                scrollPathToVisible(treePath);
            } else {
                scrollRowToVisible(0);
                setSelectionPath(null);
            }
        } else {
            scrollRowToVisible(0);
            setSelectionPath(null);
        }
        assert frame != null;
        frame.setVisible(true);
    }

    @NotNull
    private JPanel buildButtonPanel() {
        final JPanel buttonPanel = new JPanel(new BorderLayout());

        final Container leftSide = new JPanel();
        final Container rightSide = new JPanel();

        okButton.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(@NotNull final ActionEvent e) {
                final String result = getSelectedTreasureList();
                if (result != null) {
                    selectValue(result);
                }
            }

        });
        rightSide.add(okButton);

        noneButton.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(@NotNull final ActionEvent e) {
                // print "none" into the attribute dialog
                selectValue(NONE_SYM);
            }

        });
        rightSide.add(noneButton);

        final AbstractButton cancelButton = new JButton("Cancel");
        cancelButton.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(@NotNull final ActionEvent e) {
                assert frame != null;
                frame.setVisible(false);
            }

        });
        rightSide.add(cancelButton);

        final AbstractButton helpButton = new JButton("Help");
        helpButton.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(@NotNull final ActionEvent e) {
                new Help(parent, "treasurelists.html").setVisible(true);
            }

        });
        leftSide.add(helpButton);
        final Component testButton = new JButton("Test");
        leftSide.add(testButton);
        testButton.setEnabled(false); // disable test button until implemented

        buttonPanel.add(leftSide, BorderLayout.WEST);
        buttonPanel.add(rightSide, BorderLayout.EAST);
        return buttonPanel;
    }

    private void selectValue(@NotNull final String result) {
        if (input != null) {
            input.setText(" " + result);
        }
        assert frame != null;
        frame.setVisible(false);
    }

    @Nullable
    private String getSelectedTreasureList() {
        if (isSelectionEmpty()) {
            return null;
        }

        TreeNode node = (TreeNode) getSelectionPath().getLastPathComponent();

        if (node == treasureTree.getRoot()) {
            return null;
        }

        while (true) {
            final TreeNode parentNode = node.getParent();
            if (parentNode == treasureTree.getRoot()) {
                break;
            }
            node = parentNode;
        }

        // When a treasurelist inside a special sub folder (like
        // "God Intervention") is selected, also return null because those must
        // not be used on maps.
        final TreasureTreeNode treasureTreeNode = (TreasureTreeNode) node;
        if (treasureTreeNode.getTreasureObj() instanceof FolderTreasureObj) {
            ACTION_BUILDER.showMessageDialog(frame, "treasurelistForbidden", treasureTreeNode.getTreasureObj().getName());
            return null;
        }

        return treasureTreeNode.getTreasureObj().getName();
    }

}