Tab.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.utils.tabbedpanel;
 
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Insets;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.util.Collection;
import java.util.MissingResourceException;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.prefs.Preferences;
import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.JComponent;
import javax.swing.JMenu;
import javax.swing.JPopupMenu;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.gui.utils.MenuUtils;
import net.sf.gridarta.gui.utils.Severity;
import net.sf.gridarta.gui.utils.borderpanel.Location;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ToggleAction;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class Tab {
 
    private static final int SPACE = 6;
 
    @NotNull
    private static final String TAB_OPEN_PREFIX = "MainWindow.tab_open.";
 
    @NotNull
    private static final String TAB_WIDTH_PREFIX = "MainWindow.tab_width.";
 
    @NotNull
    private static final String TAB_HEIGHT_PREFIX = "MainWindow.tab_height.";
 
    @NotNull
    private static final String TAB_LOCATION = "MainWindow.tab_location.";
 
    @NotNull
    private static final String TAB_ALT_LOCATION = "MainWindow.tab_alt_location.";
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    private static final Preferences PREFERENCES = Preferences.userNodeForPackage(MainControl.class);
 
    @NotNull
    private final String ident;
 
    @NotNull
    private final JComponent component;
 
    @NotNull
    private AbstractButton button;
 
    @NotNull
    private final TabButtonAction action;
 
    @NotNull
    private final Collection<TabListener> listeners = new CopyOnWriteArrayList<>();
 
    @NotNull
    private final JPopupMenu popupMenu = ACTION_BUILDER.createPopupMenu(false, "tabButtonMenu");
 
    @NotNull
    private final JMenu moveToMenu;
 
    @Nullable
    private ToggleAction splitModeAction;
 
    @NotNull
    private Location location;
 
    private boolean alternativeLocation;
 
    private final int index;
 
    private int width;
 
    private int height;
 
    private boolean open;
 
    @NotNull
    private Severity severity = Severity.DEFAULT;
 
    @NotNull
    private final MouseListener mouseListener = new MouseAdapter() {
 
        @Override
        public void mousePressed(@NotNull final MouseEvent e) {
            checkPopup(e);
        }
 
        @Override
        public void mouseReleased(@NotNull final MouseEvent e) {
            checkPopup(e);
        }
 
        private void checkPopup(@NotNull final MouseEvent e) {
            if (e.isPopupTrigger()) {
                getPopupMenu().show(e.getComponent(), e.getX(), e.getY());
            }
        }
 
    };
 
    public Tab(@NotNull final String ident, @NotNull final JComponent component, @NotNull final Location defaultLocation, final boolean alternativeLocation, final int index, final boolean defaultOpen) {
        this.ident = ident;
        this.component = component;
        final Dimension preferredSize = component.getPreferredSize();
        final int defaultWidth = PREFERENCES.getInt(TAB_WIDTH_PREFIX + ident, preferredSize.width);
        final int defaultHeight = PREFERENCES.getInt(TAB_HEIGHT_PREFIX + ident, preferredSize.height);
        final Dimension minimumSize = component.getMinimumSize();
        width = Math.max(defaultWidth, minimumSize.width);
        height = Math.max(defaultHeight, minimumSize.height);
        open = PREFERENCES.getBoolean(TAB_OPEN_PREFIX + ident, defaultOpen);
        action = new TabButtonAction(ident);
        final String locationString = PREFERENCES.get(TAB_LOCATION + ident, defaultLocation.toString());
        try {
            location = Location.valueOf(locationString);
        } catch (final IllegalArgumentException ignored) {
            location = defaultLocation;
        }
        this.alternativeLocation = PREFERENCES.getBoolean(TAB_ALT_LOCATION + ident, alternativeLocation);
        this.index = index;
        button = createButton();
        final JMenu tmp = MenuUtils.findMenu(popupMenu, "tabButtonMoveTo");
        if (tmp == null) {
            throw new MissingResourceException("missing action ", MenuUtils.class.getName(), "tabButtonMoveTo");
        }
        moveToMenu = tmp;
    }
 
    @NotNull
    private AbstractButton createButton() {
        final int acceleratorIndex = index < 10 ? index : -1;
        action.setIndex(acceleratorIndex);
        final AbstractButton result = location.createButton((String) action.getValue(Action.NAME));
        result.setMargin(location.isTopOrBottom() ? new Insets(0, SPACE, 0, SPACE) : new Insets(SPACE, 0, SPACE, 0));
        if (acceleratorIndex != -1) {
            result.setMnemonic('0' + index);
        }
        result.addMouseListener(mouseListener);
        return result;
    }
 
    public void addTabListener(@NotNull final TabListener listener) {
        listeners.add(listener);
    }
 
    public void removeTabListener(@NotNull final TabListener listener) {
        listeners.remove(listener);
    }
 
    @NotNull
    public Component getComponent() {
        return component;
    }
 
    @NotNull
    public AbstractButton getButton() {
        return button;
    }
 
    @NotNull
    public JPopupMenu getPopupMenu() {
        return popupMenu;
    }
 
    @NotNull
    public JMenu getMoveToMenu() {
        return moveToMenu;
    }
 
    public void setSplitModeAction(@Nullable final ToggleAction splitModeAction) {
        this.splitModeAction = splitModeAction;
    }
 
    public boolean isAlternativeLocation() {
        return alternativeLocation;
    }
 
    public void setAlternativeLocation(final boolean alternativeLocation) {
        this.alternativeLocation = alternativeLocation;
        PREFERENCES.putBoolean(TAB_ALT_LOCATION + ident, alternativeLocation);
        if (splitModeAction != null) {
            splitModeAction.setSelected(alternativeLocation);
        }
    }
 
    @NotNull
    public Location getLocation() {
        return location;
    }
 
    public void setLocation(@NotNull final Location location) {
        if (this.location == location) {
            return;
        }
 
        this.location = location;
        button = createButton();
        PREFERENCES.put(TAB_LOCATION + ident, location.toString());
    }
 
    public int getSize() {
        return location.isTopOrBottom() ? height : width;
    }
 
    public void setSize(final int size) {
        if (location.isTopOrBottom()) {
            height = size;
            PREFERENCES.putInt(TAB_HEIGHT_PREFIX + ident, size);
        } else {
            width = size;
            PREFERENCES.putInt(TAB_WIDTH_PREFIX + ident, size);
        }
    }
 
    public boolean isOpen() {
        return open;
    }
 
    public void setOpen(final boolean open) {
        if (this.open == open) {
            return;
        }
 
        this.open = open;
        PREFERENCES.putBoolean(TAB_OPEN_PREFIX + ident, open);
    }
 
    @NotNull
    public Severity getSeverity() {
        return severity;
    }
 
    protected void setSeverity(@NotNull final Severity severity) {
        if (this.severity == severity) {
            return;
        }
 
        this.severity = severity;
        for (final TabListener listener : listeners) {
            listener.severityChanged(severity);
        }
    }
 
}