/*
 *------------------------------------------------------------------------------
 *  Copyright (C) 2006-2015 University of Dundee & Open Microscopy Environment.
 *  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.treeviewer.util;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.Icon;

import omero.gateway.model.GroupData;
import omero.gateway.model.ExperimenterData;

import org.openmicroscopy.shoola.agents.util.EditorUtil;
import org.openmicroscopy.shoola.util.ui.SelectableMenuItem;

/**
 * Hosts the experimenter or the group to add to the menu.
 *
 * @author Jean-Marie Burel     
 * <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
 * @since 4.4
 */
public class DataMenuItem
    extends SelectableMenuItem
    implements ActionListener
{

    /** The default text to select all the users.*/
    public static final String ALL_USERS_TEXT;

    /** The default text to toggle between users and group display.*/
    public static final String USERS_TEXT;
    
    /** Bound property indicating if the item is selected or not.*/
    public static final String ITEM_SELECTED_PROPERTY;

    static {
        ITEM_SELECTED_PROPERTY = "itemSelectedProperty";
        ALL_USERS_TEXT = "Show All Users";
        USERS_TEXT = "Display Users";
    }

    /** The object to host.*/
    private final Object data;

    /** Flag indicating if the item can be enabled or not.*/
    private boolean canBeEnabled;

    /** The string of reference.*/
    private String refString = null;

    /**
     * Creates a new instance.
     * 
     * @param data The data to host.
     * @param icon The icon to set.
     */
    public DataMenuItem(Object data, Icon icon)
    {
        this(data, icon, true);
    }

    /**
     * Creates a new instance.
     * 
     * @param data The data to host.
     * @param icon The icon to set.
     * @param canBeEnabled Flag indicating if the item can be enabled or not.
     */
    public DataMenuItem(Object data, Icon icon, boolean canBeEnabled)
    {
        super(false, data.toString(), canBeEnabled);
        if (data instanceof ExperimenterData)
            setText(EditorUtil.formatExperimenter((ExperimenterData) data));
        else if (data instanceof GroupData)
            setText(((GroupData) data).getName());
        else setText(data.toString());
        if (icon != null) setIcon(icon);
        this.canBeEnabled = canBeEnabled;
        this.data = data;
        setEnabled(true);
        addActionListener(this);
    }

    /**
     * Creates a new instance.
     * 
     * @param data The data to host.
     * @param canBeEnabled Flag indicating if the item can be enabled or not.
     */
    public DataMenuItem(Object data, boolean canBeEnabled)
    {
        this(data, null, canBeEnabled);
    }

    /**
     * Returns the string of reference or <code>null</code> if not set.
     *
     * @return See above.
     */
    public String getRefString() { return refString; }

    /**
     * Sets the the string of reference.
     *
     * @param refString The value to set.
     */
    public void setRefString(String refString)
    {
        this.refString = refString;
    }

    /**
     * Returns the data object.
     * 
     * @return See above.
     */
    public Object getDataObject() { return data; }

    /**
     * Overridden to set the enabled flag.
     * @see #setEnabled(boolean)
     */
    public void setEnabled(boolean enabled)
    {
        if (!canBeEnabled) enabled = false;
        super.setEnabled(enabled);
    }

    /**
     * Fires a property change indicating the selected or deselected object.
     *
     * @see ActionListener#actionPerformed(ActionEvent)
     */
    public void actionPerformed(ActionEvent evt)
    {
        firePropertyChange(ITEM_SELECTED_PROPERTY, null, this);
    }

}