GUILog.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.log;

import com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable2;
import com.realtime.crossfire.jxclient.gui.scrollable.ScrollableListener;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsEnvironment;
import java.awt.Image;
import java.awt.Transparency;
import java.awt.font.FontRenderContext;
import java.awt.image.BufferedImage;
import java.util.Iterator;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public abstract class GUILog extends AbstractGUIElement implements GUIScrollable2 {

    private static final long serialVersionUID = 1;

    private static final int SCROLL_PIXEL = 12;

    @NotNull
    private final EventListenerList2<ScrollableListener> listeners = new EventListenerList2<>();

    @NotNull
    private final Buffer buffer;

    @Nullable
    private final Image backgroundImage;

    @NotNull
    private final Fonts fonts;

    @NotNull
    private final RenderStateManager renderStateManager;

    @NotNull
    @SuppressWarnings("FieldCanBeLocal")
    private final RenderStateListener renderStateListener = new RenderStateListener() {

        @Override
        public void stateChanged() {
            setChanged();
            for (final ScrollableListener listener : listeners) {
                listener.setRange(0, buffer.getTotalHeight(), renderStateManager.getScrollPos(), getHeight());
            }
        }

        @Override
        public int getHeight() {
            return Math.max(1, GUILog.this.getHeight());
        }

    };

    protected GUILog(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @Nullable final Image backgroundImage, @NotNull final Fonts fonts) {
        super(tooltipManager, elementListener, name, Transparency.TRANSLUCENT);
        this.backgroundImage = backgroundImage;
        this.fonts = fonts;
        final FontRenderContext context;
        final GraphicsEnvironment graphicsEnvironment = GraphicsEnvironment.getLocalGraphicsEnvironment();
        final Graphics2D g = graphicsEnvironment.createGraphics(new BufferedImage(1, 1, BufferedImage.TYPE_INT_ARGB)); // XXX
        try {
            context = g.getFontRenderContext();
        } finally {
            g.dispose();
        }
        buffer = new Buffer(fonts, context, getWidth());
        renderStateManager = new RenderStateManager(renderStateListener, buffer);
        renderStateManager.setHeight(getHeight());
    }

    @Override
    public void dispose() {
        super.dispose();
        renderStateManager.dispose();
    }

    @Override
    public void paintComponent(@NotNull final Graphics g) {
        super.paintComponent(g);

        g.setColor(new Color(0, 0, 0, 0.0f));
        g.fillRect(0, 0, getWidth(), getHeight());
        if (backgroundImage != null) {
            g.drawImage(backgroundImage, 0, 0, null);
        }

        int y = -renderStateManager.getTopOffset();
        final int topIndex = renderStateManager.getTopIndex();
        synchronized (buffer.getSyncObject()) {
            final Iterator<Line> it = buffer.listIterator(topIndex);
            while (y < getHeight() && it.hasNext()) {
                final Line line = it.next();
                drawLine(g, y, line);
                y += line.getHeight();
            }
        }
    }

    private void drawLine(@NotNull final Graphics g, final int y, @NotNull final Iterable<Segment> line) {
        for (final Segment segment : line) {
            segment.draw(g, y, fonts);
        }
    }

    @Override
    public boolean canScroll(final int distance) { // XXX: implement |distance|>1
        if (distance < 0) {
            return renderStateManager.canScrollUp();
        }
        //noinspection SimplifiableIfStatement
        if (distance > 0) {
            return renderStateManager.canScrollDown();
        }
        return false;
    }

    @Override
    public void scroll(final int distance) {
        if (distance < 0) {
            renderStateManager.scrollUp(-distance*SCROLL_PIXEL);
        } else if (distance > 0) {
            renderStateManager.scrollDown(distance*SCROLL_PIXEL);
        } else {
            assert false;
        }
    }

    @Override
    public void resetScroll() {
        renderStateManager.resetScroll();
    }

    @Override
    public void scrollTo(final int pos) {
        renderStateManager.scrollTo(pos);
    }

    @Override
    public void addScrollableListener(@NotNull final ScrollableListener listener) {
        listeners.add(listener);
    }

    @Override
    public void removeScrollableListener(@NotNull final ScrollableListener listener) {
        listeners.remove(listener);
    }

    @NotNull
    public Buffer getBuffer() {
        return buffer;
    }

    @Override
    public void setBounds(final int x, final int y, final int width, final int height) {
        super.setBounds(x, y, width, height);
        buffer.setRenderWidth(width);
        renderStateManager.setHeight(height);
    }

    @Nullable
    @Override
    public Dimension getPreferredSize() {
        return new Dimension(600, 150); // XXX
    }

    @Nullable
    @Override
    public Dimension getMinimumSize() {
        return new Dimension(100, 10); // XXX
    }

}