Gui.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff.
 * Copyright (C) 2006-2011 Andreas Kirschbaum.
 */

package com.realtime.crossfire.jxclient.gui.gui;

import com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings;
import com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2;
import com.realtime.crossfire.jxclient.util.SwingUtilities2;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.event.KeyEvent;
import java.util.Collection;
import java.util.EnumSet;
import javax.swing.JComponent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class Gui extends JComponent {

    private static final long serialVersionUID = 1L;

    @NotNull
    private final KeyBindings keyBindings;

    @Nullable
    private Extent autoSize;

    private boolean saveDialog;

    private boolean modal;

    @NotNull
    private final Collection<RendererGuiState> hideInStates = EnumSet.noneOf(RendererGuiState.class);

    @Nullable
    private ActivatableGUIElement forcedActive;

    @Nullable
    private ActivatableGUIElement activeElement;

    private boolean initialPositionSet;

    @Nullable
    private GuiAutoCloseListener guiAutoCloseListener;

    @Nullable
    private Expression defaultX;

    @Nullable
    private Expression defaultY;

    public Gui(@NotNull final KeyBindings keyBindings) {
        this.keyBindings = keyBindings;
    }

    public void setPosition(final int x, final int y) {
        if (initialPositionSet && getX() == x && getY() == y) {
            return;
        }

        if ((getWidth() == 0 || getHeight() == 0) && (initialPositionSet || x != 0 || y != 0)) {
            throw new IllegalStateException("width="+getWidth()+", height="+getHeight()+", initialPositionSet="+initialPositionSet+", x="+x+", y="+y);
        }

        initialPositionSet = true;
        setLocation(x, y);
    }

    public void setAutoSize(@Nullable final Extent autoSize) {
        this.autoSize = autoSize;
    }

    public boolean isAutoSize() {
        return autoSize != null;
    }

    public void setModal(final boolean modal) {
        this.modal = modal;
    }

    public boolean isModal() {
        return modal;
    }

    @Nullable
    private ActivatableGUIElement getDefaultElement() {
        final int count = getComponentCount();
        for (int i = 0; i < count; i++) {
            final Component component = getComponent(i);
            if (component.isVisible() && component instanceof ActivatableGUIElement) {
                final ActivatableGUIElement element = (ActivatableGUIElement)component;
                if (element.isDefault()) {
                    return element;
                }
            }
        }

        return null;
    }

    public void activateDefaultElement() {
        final ActivatableGUIElement defaultElement = getDefaultElement();
        if (defaultElement != null) {
            defaultElement.setActive(true);
        }
    }

    @Nullable
    public <T extends GUIElement> T getFirstElementEndingWith(@NotNull final Class<T> class_, @NotNull final String ending) {
        final int count = getComponentCount();
        for (int i = 0; i < count; i++) {
            final Component component = getComponent(i);
            if (component.isVisible() && component instanceof GUIElement) {
                final GUIElement element = (GUIElement)component;
                if (class_.isAssignableFrom(element.getClass()) && element.getName().endsWith(ending)) {
                    return class_.cast(element);
                }
            }
        }

        return null;
    }

    @Nullable
    public <T extends GUIElement> T getFirstElementNotEndingWith(@NotNull final Class<T> class_, @NotNull final String ending) {
        final int count = getComponentCount();
        for (int i = 0; i < count; i++) {
            final Component component = getComponent(i);
            if (component.isVisible() && component instanceof GUIElement) {
                final GUIElement element = (GUIElement)component;
                if (class_.isAssignableFrom(element.getClass()) && !element.getName().endsWith(ending)) {
                    return class_.cast(element);
                }
            }
        }

        return null;
    }

    @Nullable
    public <T extends GUIElement> T getFirstElement(@NotNull final Class<T> class_) {
        final int count = getComponentCount();
        for (int i = 0; i < count; i++) {
            final Component component = getComponent(i);
            if (component.isVisible() && component instanceof GUIElement) {
                final GUIElement element = (GUIElement)component;
                if (class_.isAssignableFrom(element.getClass())) {
                    return class_.cast(element);
                }
            }
        }

        return null;
    }

    @Nullable
    public AbstractGUIElement getElementFromPoint(final int x, final int y) {
        Component component = findComponentAt(x, y);
        while (component != null) {
            if (component instanceof AbstractGUIElement) {
                return (AbstractGUIElement)component;
            }
            component = component.getParent();
        }
        return null;
    }

    public void setActiveElement(@NotNull final ActivatableGUIElement activeElement, final boolean active) {
        final ActivatableGUIElement previousActiveElement = this.activeElement;
        if (active) {
            if (forcedActive != null && forcedActive != activeElement) {
                return;
            }

            if (isActiveElement(activeElement)) {
                return;
            }

            this.activeElement = activeElement;
            if (previousActiveElement != null) {
                previousActiveElement.activeChanged();
            }
            assert this.activeElement != null;
            this.activeElement.activeChanged();

            guiAutoCloseListener = null;
        } else {
            if (!isActiveElement(activeElement)) {
                return;
            }

            this.activeElement = null;
            assert previousActiveElement != null;
            previousActiveElement.activeChanged();

            if (guiAutoCloseListener != null) {
                final GuiAutoCloseListener listener = guiAutoCloseListener;
                guiAutoCloseListener = null;
                listener.autoClosed();
            }
        }
    }

    public boolean isActiveElement(@Nullable final ActivatableGUIElement activeElement) {
        return this.activeElement != null && this.activeElement == activeElement;
    }

    public void setActiveElementActive(final boolean active) {
        if (activeElement != null) {
            activeElement.setActive(active);
        }
    }

    public boolean handleKeyPress(@NotNull final KeyEvent2 e) {
        if (activeElement != null && activeElement instanceof KeyPressedHandler && ((KeyPressedHandler)activeElement).keyPressed(e)) {
            return true;
        }

        if (activeElement instanceof KeyPressedHandler) {
            final KeyPressedHandler keyListener = (KeyPressedHandler)activeElement;
            if (keyListener.keyPressed(e)) {
                return true;
            }
        }

        switch (e.getKeyCode()) {
        case KeyEvent.VK_ENTER:
        case KeyEvent.VK_SPACE:
            final ActivatableGUIElement defaultElement = getDefaultElement();
            if (defaultElement != null) {
                defaultElement.execute();
                return true;
            }
            break;
        }

        return keyBindings.handleKeyPress(e);
    }

    public boolean deactivateCommandInput() {
        if (activeElement == null) {
            return false;
        }

        final GUIElement textArea = activeElement;
        if (!textArea.getName().equals("command")) {
            return false;
        }

        assert activeElement != null;
        activeElement.setActive(false);
        return true;
    }

    @Nullable
    public <T extends GUIElement> T getFirstElement(@NotNull final Class<T> class_, @NotNull final String name) {
        final int count = getComponentCount();
        for (int i = 0; i < count; i++) {
            final Component component = getComponent(i);
            if (component.isVisible() && component instanceof GUIElement) {
                final GUIElement element = (GUIElement)component;
                if (class_.isAssignableFrom(element.getClass()) && element.getName().equals(name)) {
                    return class_.cast(element);
                }
            }
        }
        return null;
    }

    @NotNull
    public KeyBindings getKeyBindings() {
        return keyBindings;
    }

    public void hideInState(@NotNull final RendererGuiState state) {
        hideInStates.add(state);
    }

    public boolean isHidden(@NotNull final RendererGuiState state) {
        return hideInStates.contains(state);
    }

    public void setGuiAutoCloseListener(@Nullable final GuiAutoCloseListener guiAutoCloseListener) {
        this.guiAutoCloseListener = guiAutoCloseListener;
    }

    public boolean isWithinDrawingArea(final int x, final int y) {
        return getX() <= x && x < getX()+getWidth() && getY() <= y && y < getY()+getHeight();
    }

    public void setForcedActive(@Nullable final ActivatableGUIElement forcedActive) {
        this.forcedActive = forcedActive;
    }

    @NotNull
    @Override
    public String toString() {
        final String name = getName();
        return (name == null ? "" : name)+"["+getWidth()+"x"+getHeight()+"]";
    }

    public void autoSize(final int screenWidth, final int screenHeight) {
        SwingUtilities2.invokeAndWait(() -> {
            final Extent extent = autoSize;
            if (extent != null) {
                final Dimension preferredSize = getPreferredSize();
                setBounds(extent.getX(screenWidth, screenHeight, preferredSize.width, preferredSize.height), extent.getY(screenWidth, screenHeight, preferredSize.width, preferredSize.height), extent.getW(screenWidth, screenHeight, preferredSize.width, preferredSize.height), extent.getH(screenWidth, screenHeight, preferredSize.width, preferredSize.height));
            } else if (!initialPositionSet) {
                final Dimension preferredSize = getPreferredSize();
                final int x;
                //noinspection IfMayBeConditional
                if (defaultX == null) {
                    x = (screenWidth-preferredSize.width)/2;
                } else {
                    x = defaultX.evaluate(screenWidth, screenHeight, preferredSize.width, preferredSize.height);
                }
                final int y;
                //noinspection IfMayBeConditional
                if (defaultY == null) {
                    y = (screenHeight-preferredSize.height)/2;
                } else {
                    y = defaultY.evaluate(screenWidth, screenHeight, preferredSize.width, preferredSize.height);
                }
                setSize(preferredSize.width, preferredSize.height);
                if (defaultX != null && defaultY != null) {
                    setPosition(x-preferredSize.width/2, y-preferredSize.height/2);
                }
            }
        });

        showDialog(getX(), getY(), screenWidth, screenHeight);
    }

    public void setDefaultPosition(@NotNull final Expression defaultX, @NotNull final Expression defaultY) {
        this.defaultX = defaultX;
        this.defaultY = defaultY;
    }

    public boolean isSaveDialog() {
        return saveDialog;
    }

    public void setSaveDialog() {
        saveDialog = true;
    }

    public void showDialog(final int x, final int y, final int windowWidth, final int windowHeight) {
        final int newX;
        final int newY;
        if (isAutoSize()) {
            newX = x;
            newY = y;
        } else {
            newX = Math.max(Math.min(x, windowWidth-getWidth()), 0);
            newY = Math.max(Math.min(y, windowHeight-getHeight()), 0);
        }
        setPosition(newX, newY);
    }

}