ScriptEditView.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.textedit.scripteditor;

import java.awt.Frame;
import java.awt.Rectangle;
import java.awt.geom.RectangularShape;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.List;
import java.util.prefs.Preferences;
import javax.swing.JDialog;
import javax.swing.JOptionPane;
import javax.swing.JTabbedPane;
import javax.swing.SwingConstants;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.text.BadLocationException;
import net.sf.gridarta.textedit.textarea.JEditTextArea;
import net.sf.gridarta.textedit.textarea.SyntaxDocument;
import net.sf.gridarta.textedit.textarea.TextAreaDefaults;
import net.sf.gridarta.textedit.textarea.tokenmarker.TokenMarkerFactory;
import net.sf.gridarta.utils.Exiter;
import net.sf.gridarta.utils.ExiterListener;
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 ScriptEditView extends JDialog {

    @NotNull
    private static final Category LOG = Logger.getLogger(ScriptEditView.class);

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

    @NotNull
    private TextAreaDefaults textAreaDefaults;

    private static final long serialVersionUID = 1L;

    @NotNull
    private static final String WINDOW_X = "ScriptEditWindow.x";

    @NotNull
    private static final String WINDOW_Y = "ScriptEditWindow.y";

    @NotNull
    private static final String WINDOW_WIDTH = "ScriptEditWindow.width";

    @NotNull
    private static final String WINDOW_HEIGHT = "ScriptEditWindow.height";

    @NotNull
    private final Actions actions;

    @NotNull
    private final ScriptEditUndoActions scriptEditUndoActions;

    @NotNull
    private final JTabbedPane tabPane;       // tab pane

    @NotNull
    private final List<JEditTextArea> textAreas;          // list of 'JEditTextArea' objects, same order as tabs

    public ScriptEditView(@NotNull final ScriptEditControl control, @NotNull final Frame owner, @NotNull final Preferences preferences, @NotNull final Exiter exiter) {
        super(owner, "Script Pad");
        setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);

        textAreas = new ArrayList<>();
        actions = new Actions(control);
        scriptEditUndoActions = new ScriptEditUndoActions();
        setJMenuBar(ACTION_BUILDER.createMenuBar(true, "scriptEditMenu"));

        tabPane = new JTabbedPane(SwingConstants.TOP); // init tab pane
        tabPane.addChangeListener(new EditTabListener(this));

        getContentPane().add(tabPane);
        addWindowListener(new EditWindowListener(control)); // add listener for close box

        // calculate some default values in case there is no settings file
        final RectangularShape screen = getGraphicsConfiguration().getBounds();
        final int width = preferences.getInt(WINDOW_WIDTH, (int) (0.8 * screen.getWidth()));
        final int height = preferences.getInt(WINDOW_HEIGHT, (int) (0.8 * screen.getHeight()));
        final int x = preferences.getInt(WINDOW_X, (int) (screen.getX() + (screen.getWidth() - (double) width) / 2.0));
        final int y = preferences.getInt(WINDOW_Y, (int) (screen.getY() + (screen.getHeight() - (double) height) / 2.0));
        setBounds(x, y, width, height);

        final ExiterListener exiterListener = new ExiterListener() {

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

            @Override
            public void appExitNotify() {
                final Rectangle bounds = getBounds();
                preferences.putInt(WINDOW_X, bounds.x);
                preferences.putInt(WINDOW_Y, bounds.y);
                preferences.putInt(WINDOW_WIDTH, bounds.width);
                preferences.putInt(WINDOW_HEIGHT, bounds.height);
            }

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

        };
        exiter.addExiterListener(exiterListener);
    }

    @Deprecated
    public void setTextAreaDefaults(@NotNull final TextAreaDefaults textAreaDefaults) {
        this.textAreaDefaults = textAreaDefaults;
    }

    public void addTab(@NotNull final String title, @Nullable final File file) {
        final SyntaxDocument syntaxDocument = new SyntaxDocument();
        syntaxDocument.setTokenMarker(TokenMarkerFactory.createTokenMarker(file));
        final JEditTextArea ta = new JEditTextArea(textAreaDefaults, syntaxDocument, textAreaDefaults.getPaintInvalid()); // open new TextArea
        //ta.setFont(new Font("Courier New", Font.PLAIN, 12));
        textAreas.add(ta);
        scriptEditUndoActions.addDocument(syntaxDocument);
        tabPane.addTab(title, ta);
        if (getTabCount() <= 1 || !isShowing()) {
            setVisible(true);
        }

        scriptEditUndoActions.setCurrentDocument(syntaxDocument);

        tabPane.setSelectedIndex(getTabCount() - 1);

        // very important: There must be a drawing update after showing the frame, to make
        // sure the graphics context is fully initialized before calling 'setEditingFocus()'
        //if (isFirstTimeShowing) {
        update(getGraphics());
        //}

        if (file != null && file.exists()) {
            // print file into this document
            try {
                try (FileInputStream fis = new FileInputStream(file)) {
                    try (InputStreamReader isr = new InputStreamReader(fis)) {
                        try (BufferedReader in = new BufferedReader(isr)) {
                            boolean firstLine = true;
                            final StringBuilder buff = new StringBuilder("");
                            while (true) {
                                final String line = in.readLine();
                                if (line == null) {
                                    break;
                                }
                                if (firstLine) {
                                    firstLine = false;
                                } else {
                                    buff.append('\n');
                                }
                                buff.append(line);
                            }
                            syntaxDocument.insertString(0, buff.toString(), null);
                        }
                    }
                }
                // insert buffer into the document
            } catch (final FileNotFoundException e) {
                if (LOG.isInfoEnabled()) {
                    LOG.info("addTab(): File '" + file.getName() + "' not found.");
                }
            } catch (final IOException e) {
                if (LOG.isInfoEnabled()) {
                    LOG.info("addTab(): I/O-Error while reading '" + file.getName() + "'.");
                }
            } catch (final BadLocationException e) {
                if (LOG.isInfoEnabled()) {
                    LOG.info("addTab(): Bad Location in Document!");
                }
            }
            scriptEditUndoActions.resetUndo(syntaxDocument);
        }

        ta.setEditingFocus(); // set focus to TextArea in order to respond to key press events
        //ta.scrollToCaret();   // make sure the window shows caret (top left corner)

        ta.resetModified();

        toFront(); // bring window to front
    }

    public void closeActiveTab() {
        if (textAreas.isEmpty()) {
            setVisible(false);
        } else {
            final int oldIndex = tabPane.getSelectedIndex();
            final int newIndex = oldIndex >= tabPane.getTabCount() - 1 ? oldIndex - 1 : oldIndex;
            tabPane.setSelectedIndex(newIndex);
            scriptEditUndoActions.removeDocument(textAreas.get(oldIndex).getDocument());
            textAreas.remove(oldIndex);
            tabPane.remove(oldIndex);
            actions.refresh();
            scriptEditUndoActions.setCurrentDocument(newIndex == -1 ? null : textAreas.get(newIndex).getDocument());
        }
    }

    @Nullable
    public JEditTextArea getActiveTextArea() {
        if (getTabCount() > 0) {
            return textAreas.get(tabPane.getSelectedIndex());
        }

        return null; // no window is open
    }

    public int getSelectedIndex() {
        return tabPane.getSelectedIndex();
    }

    public int getTabCount() {
        return tabPane.getTabCount();
    }

    public void setTitleAt(final int index, @NotNull final String title) {
        tabPane.setTitleAt(index, title);
    }

    @Nullable
    public String getActiveTitle() {
        return getTabCount() > 0 ? tabPane.getTitleAt(tabPane.getSelectedIndex()) : null;
    }

    public boolean askConfirm(@NotNull final String title, @NotNull final String message) {
        return JOptionPane.showConfirmDialog(this, message, title, JOptionPane.YES_NO_OPTION, JOptionPane.INFORMATION_MESSAGE) == JOptionPane.YES_OPTION;
    }

    public void showMessage(@NotNull final String title, @NotNull final String message, final int messageType) {
        JOptionPane.showMessageDialog(this, message, title, messageType);
    }

    public void showMessage(@NotNull final String title, @NotNull final String message) {
        JOptionPane.showMessageDialog(this, message, title, JOptionPane.INFORMATION_MESSAGE);
    }

    private class EditTabListener implements ChangeListener {

        @NotNull
        private final ScriptEditView view;       // view

        private int index;                 // index of selected tab

        private EditTabListener(@NotNull final ScriptEditView view) {
            this.view = view;
            index = view.getSelectedIndex();
        }

        @Override
        public void stateChanged(@NotNull final ChangeEvent e) {
            if (index != view.getSelectedIndex()) {
                index = view.getSelectedIndex();
                // active selected tab has changed
                actions.refresh(); // refresh state of menus
                scriptEditUndoActions.setCurrentDocument(index == -1 ? null : textAreas.get(index).getDocument());
            }
        }

    }

}