/*
* org.openmicroscopy.shoola.agents.treeviewer.actions.SwitchGroup
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2012 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.actions;
//Java imports
import java.awt.Component;
import java.awt.Point;
import java.awt.event.ActionEvent;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import javax.swing.Action;
import javax.swing.SwingUtilities;
//Third-party libraries
//Application-internal dependencies
import org.openmicroscopy.shoola.agents.treeviewer.IconManager;
import org.openmicroscopy.shoola.agents.treeviewer.view.TreeViewer;
import org.openmicroscopy.shoola.util.ui.UIUtilities;
/**
* Selects the groups to add to the display.
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @since Beta4.4
*/
public class SwitchGroup
extends TreeViewerAction
implements MouseListener
{
/** The name of the action. */
public static final String NAME = "Display Group...";
/** The description of the action. */
public static final String DESCRIPTION = "Select the groups to " +
"add to the tree.";
/** The location of the mouse pressed. */
private Point point;
/**
* Creates a new instance.
*
* @param model Reference to the Model. Mustn't be <code>null</code>.
*/
public SwitchGroup(TreeViewer model)
{
super(model);
setEnabled(true);
name = NAME;
putValue(Action.SHORT_DESCRIPTION,
UIUtilities.formatToolTipText(DESCRIPTION));
IconManager im = IconManager.getInstance();
putValue(Action.SMALL_ICON, im.getIcon(IconManager.OWNER_GROUP));
}
/**
* Sets the mouse pressed point.
*
* @param point The value to set.
*/
public void setPoint(Point point) { this.point = point; }
/**
* Brings up the switch user dialog.
* @see java.awt.event.ActionListener#actionPerformed(ActionEvent)
*/
public void actionPerformed(ActionEvent e)
{
if (point != null) {
SwingUtilities.convertPointToScreen(point,
((Component) e.getSource()));
}
model.displayUserGroups(point);
}
/**
* Sets the location of the point where the <code>mousePressed</code>
* event occurred.
* @see MouseListener#mousePressed(MouseEvent)
*/
public void mousePressed(MouseEvent me) { point = me.getPoint(); }
/**
* Required by {@link MouseListener} I/F but not actually needed in our
* case, no-operation implementation.
* @see MouseListener#mouseReleased(MouseEvent)
*/
public void mouseReleased(MouseEvent me) {}
/**
* Required by {@link MouseListener} I/F but not actually needed in our
* case, no-operation implementation.
* @see MouseListener#mouseEntered(MouseEvent)
*/
public void mouseEntered(MouseEvent e) {}
/**
* Required by {@link MouseListener} I/F but not actually needed in our
* case, no-operation implementation.
* @see MouseListener#mouseExited(MouseEvent)
*/
public void mouseExited(MouseEvent e) {}
/**
* Required by {@link MouseListener} I/F but not actually needed in our
* case, no-operation implementation.
* @see MouseListener#mouseClicked(MouseEvent)
*/
public void mouseClicked(MouseEvent e) {}
}