jitsi/src/net/java/sip/communicator/impl/swingnotification/PopupMessageHandlerSwingImpl.java

/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.impl.swingnotification;

import java.awt.*;
import java.awt.event.*;
import java.util.*;
import java.util.List;
import javax.swing.*;

import javax.swing.Timer;
import net.java.sip.communicator.service.systray.*;
import net.java.sip.communicator.service.systray.event.*;
import net.java.sip.communicator.util.*;
import net.java.sip.communicator.util.swing.*;

/**
 * An implementation of <tt>PopupMessageHandler</tt> using swing.
 * @author Symphorien Wanko
 */
public class PopupMessageHandlerSwingImpl implements PopupMessageHandler
{

    /** logger for the <tt>PopupMessageHandlerSwingImpl</tt> class */
    private final Logger logger =
        Logger.getLogger(PopupMessageHandlerSwingImpl.class);

    /** The list of all added popup listeners */
    private final List<SystrayPopupMessageListener> popupMessageListeners =
        new Vector<SystrayPopupMessageListener>();

    /** An icon representing the contact from which the notification comes */
    private ImageIcon defaultIcon =
        SwingNotificationActivator.getResources().getImage(
        "service.gui.DEFAULT_USER_PHOTO");;

    /**
     * Adds a listerner to receive popup events
     * @param listener the listener to add
     */
    public void addPopupMessageListener(SystrayPopupMessageListener listener)
    {
        synchronized (popupMessageListeners)
        {
            if (!popupMessageListeners.contains(listener))
                popupMessageListeners.add(listener);
        }
    }

    /**
     * Removes a listerner previously added with <tt>addPopupMessageListener</tt>
     * @param listener the listener to remove
     */
    public void removePopupMessageListener(SystrayPopupMessageListener listener)
    {
        synchronized (popupMessageListeners)
        {
            popupMessageListeners.remove(listener);
        }
    }

    /**
     * Implements <tt>PopupMessageHandler#showPopupMessage()</tt>
     *
     * @param popupMessage the message we will show
     */
    public void showPopupMessage(PopupMessage popupMessage)
    {
        final GraphicsConfiguration graphicsConf =
            GraphicsEnvironment.getLocalGraphicsEnvironment().
            getDefaultScreenDevice().
            getDefaultConfiguration();

        final JWindow notificationWindow = new JWindow(graphicsConf);
        notificationWindow.setPreferredSize(new Dimension(225, 125));

        final Timer popupTimer = new Timer(10000, new ActionListener()
        {

            public void actionPerformed(ActionEvent e)
            {
                if (notificationWindow.isVisible())
                    new Thread(new PopupDiscarder(notificationWindow)).start();
            }
        });

        popupTimer.setRepeats(false);

        notificationWindow.addMouseListener(new MouseAdapter()
        {

            @Override
            public void mouseEntered(MouseEvent e)
            {
                popupTimer.stop();
            }

            @Override
            public void mouseExited(MouseEvent e)
            {
                popupTimer.start();
            }

            @Override
            public void mouseClicked(MouseEvent e)
            {
                firePopupMessageClicked(new SystrayPopupMessageEvent(e));
                notificationWindow.dispose();
            }
        });

        if (popupMessage.getComponent() != null)
            notificationWindow.add(popupMessage.getComponent());
        else
            notificationWindow.add(createPopup(
                popupMessage.getMessageTitle(),
                popupMessage.getMessage(),
                popupMessage.getIcon()));
        notificationWindow.setAlwaysOnTop(true);
        notificationWindow.pack();

        new Thread(new PopupLauncher(notificationWindow, graphicsConf)).start();
        popupTimer.start();
    }

    /**
     * builds the popup component with given informations.
     * 
     * @param title message title
     * @param message message content
     * @param icon message icon
     * @return
     */
    private JComponent createPopup(String title, String message,
        ImageIcon icon)
    {
        String msg;

        if (message.length() > 70)
            msg = "<html><b>" + message.substring(0, 77) + "...";
        else
            msg = "<html><b>" + message;

        JLabel msgContent = new JLabel(msg);

        if (title.length() > 40)
            title = title.substring(0, 28) + "...";
        JLabel msgFrom = new JLabel(title);
        msgFrom.setForeground(Color.DARK_GRAY);

        JLabel msgIcon = (icon == null) ?
            new JLabel(defaultIcon) :
            new JLabel(icon);
        msgIcon.setOpaque(false);
        msgIcon.setPreferredSize(new Dimension(45, 45));

        JPanel notificationContent = new JPanel(new BorderLayout(5, 1));
        notificationContent.setBorder(
                BorderFactory.createEmptyBorder(10, 10, 10, 10));
        notificationContent.setOpaque(false);

        notificationContent.add(msgFrom, BorderLayout.NORTH);
        notificationContent.add(msgContent, BorderLayout.CENTER);
        notificationContent.add(msgIcon, BorderLayout.WEST);

        return new PopupNotificationPanel(notificationContent);
    }

    /**
     * Notifies all interested listeners that a <tt>SystrayPopupMessageEvent</tt>
     * occured.
     *
     * @param SystrayPopupMessageEvent the evt to send to listener.
     */
    private void firePopupMessageClicked(SystrayPopupMessageEvent evt)
    {
        logger.trace("Will dispatch the following popup event: " + evt);

        List<SystrayPopupMessageListener> listeners;
        synchronized (popupMessageListeners)
        {
            listeners =
                new ArrayList<SystrayPopupMessageListener>(
                popupMessageListeners);
        }

        for (SystrayPopupMessageListener listener : listeners)
            listener.popupMessageClicked(evt);
    }

    /**
     * Implements <tt>toString</tt> from <tt>PopupMessageHandler</tt>
     * @return a description of this handler
     */
    public String toString()
    {
        return SwingNotificationActivator.getResources()
            .getI18NString("impl.swingnotification.POPUP_MESSAGE_HANDLER");
    }

    /**
     * provide animation to hide a popup. The animation could be described
     * as an "inverse" of the one made by <tt>PopupLauncher</tt>.
     */
    class PopupDiscarder implements Runnable
    {

        private JWindow notificationWindow;

        PopupDiscarder(JWindow notificationWindow)
        {
            this.notificationWindow = notificationWindow;
        }

        public void run()
        {
            int height = notificationWindow.getY();
            int x = notificationWindow.getX();
            do
            {
                notificationWindow.setLocation(
                    x,
                    notificationWindow.getY() + 2);
                try
                {
                    Thread.sleep(10);
                    height -= 2;
                } catch (InterruptedException ex)
                {
                    logger.warn("exception while discarding" +
                        " popup notification window :", ex);
                }
            } while (height > 0);
            notificationWindow.dispose();
        }
    }

    /**
     * provide animation to show a popup. The popup comes from the bottom of
     * screen and will stay in the bottom right corner.
     */
    class PopupLauncher implements Runnable
    {

        private final JWindow notificationWindow;

        private final int x;

        private final int y;

        PopupLauncher(JWindow notificationWindow,
            GraphicsConfiguration graphicsConf)
        {
            this.notificationWindow = notificationWindow;

            final Rectangle rec = graphicsConf.getBounds();

            final Insets ins =
                Toolkit.getDefaultToolkit().getScreenInsets(graphicsConf);

            x = rec.width + rec.x -
                ins.right - notificationWindow.getWidth() - 1;

            y = rec.height + rec.y -
                ins.bottom - notificationWindow.getHeight() - 1;

            notificationWindow.setLocation(x, rec.height);
            notificationWindow.setVisible(true);
        }

        public void run()
        {
            int height = y - notificationWindow.getY();
            do
            {
                notificationWindow.setLocation(
                    x,
                    notificationWindow.getY() - 2);
                try
                {
                    Thread.sleep(10);
                    height += 2;
                } catch (InterruptedException ex)
                {
                    logger.warn("exception while showing" +
                        " popup notification window :", ex);
                }
            } while (height < 0);
        }
    }
}