/*
*------------------------------------------------------------------------------
* Copyright (C) 2006 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.treeviewer.actions;
import java.awt.Component;
import java.awt.Point;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import javax.swing.Action;
import org.openmicroscopy.shoola.agents.treeviewer.IconManager;
import org.openmicroscopy.shoola.agents.treeviewer.browser.Browser;
import org.openmicroscopy.shoola.agents.treeviewer.view.TreeViewer;
import org.openmicroscopy.shoola.agents.util.browser.TreeImageDisplay;
import org.openmicroscopy.shoola.util.ui.UIUtilities;
import omero.gateway.model.ExperimenterData;
import omero.gateway.model.GroupData;
/**
* Brings up the <code>Manager</code> menu.
*
* @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
* @since OME2.2
*/
public class ManagerAction
extends TreeViewerAction
implements MouseListener
{
/** The description of the action. */
private static final String DESCRIPTION = "Manage the data. " +
"Press (Shift) to keep the menu on screen when making the " +
"selection.";
/** The location of the mouse pressed. */
private Point point;
/**
* Sets the action enabled depending on the state of the {@link Browser}.
* @see TreeViewerAction#onBrowserStateChange(Browser)
*/
protected void onBrowserStateChange(Browser browser)
{
if (browser == null) return;
switch (browser.getState()) {
case Browser.LOADING_DATA:
case Browser.LOADING_LEAVES:
case Browser.COUNTING_ITEMS:
setEnabled(false);
break;
default:
onDisplayChange(browser.getLastSelectedDisplay());
break;
}
}
/**
* Modifies the name of the action and sets it enabled depending on
* the selected type.
* @see TreeViewerAction#onDisplayChange(TreeImageDisplay)
*/
protected void onDisplayChange(TreeImageDisplay selectedDisplay)
{
if (selectedDisplay == null) {
setEnabled(false);
return;
}
Object ho = selectedDisplay.getUserObject();
setEnabled(!(ho instanceof String || ho instanceof ExperimenterData ||
ho instanceof GroupData));
}
/**
* Creates a new instance.
*
* @param model Reference to the Model. Mustn't be <code>null</code>.
*/
public ManagerAction(TreeViewer model)
{
super(model);
putValue(Action.SHORT_DESCRIPTION,
UIUtilities.formatToolTipText(DESCRIPTION));
IconManager im = IconManager.getInstance();
putValue(Action.SMALL_ICON, im.getIcon(IconManager.DATA_MANAGER));
}
/**
* 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(); }
/**
* Brings up the menu.
* @see MouseListener#mouseReleased(MouseEvent)
*/
public void mouseReleased(MouseEvent me)
{
Object source = me.getSource();
if (point == null) point = me.getPoint();
if (source instanceof Component && isEnabled())
model.showMenu(TreeViewer.MANAGER_MENU, (Component) source, point);
}
/**
* 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) {}
}