/*
 *------------------------------------------------------------------------------
 *  Copyright (C) 2006-2015 University of Dundee. All rights reserved.
 *
 *
 *  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 org.openmicroscopy.shoola.agents.util;

import java.awt.Color;
import java.awt.Font;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.image.BufferedImage;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.List;
import javax.swing.AbstractButton;
import javax.swing.ImageIcon;
import javax.swing.JLabel;

import org.openmicroscopy.shoola.env.rnd.RndProxyDef;
import org.openmicroscopy.shoola.util.image.geom.Factory;
import org.openmicroscopy.shoola.util.ui.UIUtilities;
import omero.gateway.model.ExperimenterData;

/**
 * Displays the name of the experimenter who viewed the image and how he/she
 * viewed it.
 * 
 * @author Jean-Marie Burel      <a
 *         href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
 * @author Donald MacDonald      <a
 *         href="mailto:donald@lifesci.dundee.ac.uk"
 *         >donald@lifesci.dundee.ac.uk</a>
 * @version 3.0 <small> (<b>Internal version:</b> $Revision: $Date: $) </small>
 * @since 3.0-Beta4
 */
public class ViewedByItem extends JLabel {

    /** The maximum width or height of the icon. */
    public static final int MAX_ICON_SIZE = 82;

    /** Bound property indicating to apply the rendering settings. */
    public static final String VIEWED_BY_PROPERTY = "viewedBy";

    /** The experimenter who viewed the image. */
    private ExperimenterData experimenter;

    /** The rendering settings. */
    private RndProxyDef rndDef;

    /** The image with the rendering settings. */
    private BufferedImage image;

    /** Flag indicating that the item should be selected by default.*/
    private boolean selected;

    /**
     * Creates a new instance.
     * 
     * @param experimenter
     *            The experimenter who viewed the image.
     * @param rndDef
     *            The rendering settings.
     */
    public ViewedByItem(ExperimenterData experimenter, final RndProxyDef rndDef) {
        this(experimenter, rndDef, false);
    }
    
    /**
     * Creates a new instance.
     * 
     * @param experimenter
     *            The experimenter who viewed the image.
     * @param rndDef
     *            The rendering settings.
     * @param isOwnerRndDef Indicates that this is the 
     *            image owner's rendering settings
     */
    public ViewedByItem(ExperimenterData experimenter, final RndProxyDef rndDef, boolean isOwnerRndDef) {
        this.experimenter = experimenter;
        this.rndDef = rndDef;
        Font f = getFont();
        setFont(f.deriveFont(f.getStyle(), f.getSize() - 3));
        setVerticalTextPosition(AbstractButton.BOTTOM);
        setHorizontalTextPosition(AbstractButton.CENTER);
        setIconTextGap(0);
        setText(experimenter.getFirstName()+" "+experimenter.getLastName());

        if(isOwnerRndDef) {
            setForeground(Color.BLUE);
        }
        
        List<String> l = new ArrayList<String>();
        l.add("Viewed by: " + getText());
        Timestamp time = rndDef.getLastModified();
        if (time != null)
            l.add("Last modified: " + UIUtilities.formatDefaultDate(time));
        setToolTipText(UIUtilities.formatToolTipText(l));
        
        addMouseListener(new MouseAdapter() {

            public void mouseClicked(MouseEvent arg0) {
                firePropertyChange(VIEWED_BY_PROPERTY, null, rndDef);
            }     

        });
    }

    /**
     * Indicates that the element should be selected by default or not.
     *
     * @param selected The value to set.
     */
    public void setSelected(boolean selected)
    {
        this.selected = selected;
    }

    /**
     * Returns <code>true</code> if the item is selected,
     * <code>false</code> otherwise.
     *
     * @return See above.
     */
    public boolean isSelected() { return selected; }

    /**
     * Returns the experimenter the settings belong to.
     * 
     * @return See above.
     */
    public ExperimenterData getExperimenter() {
        return experimenter;
    }

    /**
     * Returns the rendering settings.
     * 
     * @return See above.
     */
    public RndProxyDef getRndDef() {
        return rndDef;
    }

    /**
     * Returns the identifier of the experimenter.
     * 
     * @return See above.
     */
    public long getExperimenterID() {
        return experimenter.getId();
    }

    /**
     * Returns the image or <code>null</code>.
     * 
     * @return See above.
     */
    public BufferedImage getImage() {
        return image;
    }

    /**
     * Sets the image as viewed by the experimenter.
     * 
     * @param image
     *            The value to set.
     */
    public void setImage(BufferedImage image) {
        this.image = image;
        if (image == null)
            return;
        setIcon(new ImageIcon(Factory.scaleBufferedImage(image, MAX_ICON_SIZE)));

        revalidate();
        repaint();
    }

}