AbstractGUIElement.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.util.SwingUtilities2;
import java.awt.Transparency;
import java.awt.event.MouseEvent;
import javax.swing.JComponent;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public abstract class AbstractGUIElement extends JComponent implements GUIElement {

    private static final long serialVersionUID = 1;

    @Nullable
    private GUIElementChangedListener changedListener;

    private boolean isDefault;

    private boolean ignore;

    @NotNull
    private final String name;

    @NotNull
    private final TooltipManager tooltipManager;

    @NotNull
    private final GUIElementListener elementListener;

    private boolean pendingChange;

    @NotNull
    private final Runnable setChangedRunnable = new Runnable() {

        @Override
        public void run() {
            synchronized (setChangedRunnable) {
                pendingChange = false;
            }
            final Gui parent = GuiUtils.getGui(AbstractGUIElement.this);
            if (parent != null) {
                parent.repaint();
            }
            if (isVisible()) {
                if (changedListener != null) {
                    changedListener.notifyChanged();
                }
            }
        }

    };

    protected AbstractGUIElement(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final int transparency) {
        setDoubleBuffered(false);
        this.tooltipManager = tooltipManager;
        this.elementListener = elementListener;
        this.name = name;
        setOpaque(transparency != Transparency.TRANSLUCENT);
        setFocusable(false);
    }

    @Override
    public void dispose() {
    }

    @NotNull
    @Override
    public String toString() {
        return name;
    }

    @Override
    public boolean isDefault() {
        return isDefault;
    }

    @Override
    public void setDefault(final boolean isDefault) {
        this.isDefault = isDefault;
    }

    @Override
    public void setIgnore() {
        ignore = true;
    }

    @Override
    public boolean isIgnore() {
        return ignore;
    }

    @NotNull
    @Override
    public String getName() {
        return name;
    }

    @Override
    public void mouseClicked(@NotNull final MouseEvent e) {
        elementListener.raiseDialog(this);
    }

    @Override
    public void mouseEntered(@NotNull final MouseEvent e, final boolean debugGui) {
        tooltipManager.setElement(this);
    }

    @Override
    public void mouseExited(@NotNull final MouseEvent e) {
        tooltipManager.unsetElement(this);
    }

    @Override
    public void mousePressed(@NotNull final MouseEvent e) {
        elementListener.raiseDialog(this);
    }

    @Override
    public void mouseReleased(@NotNull final MouseEvent e) {
    }

    @Override
    public void mouseMoved(@NotNull final MouseEvent e) {
    }

    @Override
    public void mouseDragged(@NotNull final MouseEvent e) {
    }

    @Override
    public void setChanged() {
        synchronized (setChangedRunnable) {
            if (!pendingChange) {
                pendingChange = true;
                SwingUtilities2.invokeLater(setChangedRunnable);
            }
        }
    }

    @Override
    public void setTooltipText(@Nullable final String tooltipText) {
        tooltipManager.setTooltipText(this, tooltipText);
    }

    @Override
    public void setTooltipText(@Nullable final String tooltipText, final int x, final int y, final int w, final int h) {
        tooltipManager.setTooltipText(this, tooltipText, x, y, w, h);
    }

    @Override
    public boolean hasTooltipText() {
        return tooltipManager.hasTooltipText(this);
    }

    @Override
    public void setChangedListener(@Nullable final GUIElementChangedListener changedListener) {
        this.changedListener = changedListener;
    }

}