/*
*------------------------------------------------------------------------------
* 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.metadata.editor;
import java.awt.Color;
import java.awt.Component;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.Point;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import org.openmicroscopy.shoola.agents.metadata.IconManager;
import org.openmicroscopy.shoola.agents.metadata.MetadataViewerAgent;
import org.openmicroscopy.shoola.env.event.EventBus;
import org.openmicroscopy.shoola.util.ui.UIUtilities;
import org.openmicroscopy.shoola.util.ui.omeeditpane.OMEWikiComponent;
import org.openmicroscopy.shoola.util.ui.omeeditpane.WikiDataObject;
import org.openmicroscopy.shoola.agents.events.iviewer.ViewImage;
import org.openmicroscopy.shoola.agents.events.iviewer.ViewImageObject;
import omero.gateway.model.TextualAnnotationData;
/**
* Component displaying a textual annotation.
*
* @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 OME3.0
*/
class TextualAnnotationComponent
extends JPanel
implements ActionListener, PropertyChangeListener
{
/** Action id to edit the comment.*/
private static final int EDIT = 0;
/** Action id to delete the comment.*/
private static final int DELETE = 1;
/** Area displaying the textual annotation. */
private OMEWikiComponent area;
/** The annotation to handle. */
private TextualAnnotationData data;
/** Reference to the model. */
private EditorModel model;
/** Button to edit the annotation. */
private JMenuItem editButton;
/** Button to delete the file annotation. */
private JMenuItem deleteButton;
/** The Button used to display the managing option. */
private JButton menuButton;
/** The pop-up menu. */
private JPopupMenu popMenu;
/** The bar displaying the controls.*/
private JPanel controlsBar;
/** Edits the comment.*/
private void editComment()
{
}
/** Initializes the UI components. */
private void initialize()
{
area = new OMEWikiComponent(false);
area.setEnabled(false);
area.setOpaque(true);
area.setForeground(UIUtilities.DEFAULT_FONT_COLOR);
area.setText(data.getText());
area.setAllowOneClick(true);
area.addPropertyChangeListener(this);
area.setWrapWord(true);
addComponentListener(new ComponentAdapter() {
public void componentResized(ComponentEvent e) {
area.wrapText(getSize().width, null);
}
});
IconManager icons = IconManager.getInstance();
if (model.canEdit(data)) {
editButton = new JMenuItem(icons.getIcon(IconManager.EDIT_12));
editButton.setText("Edit");
editButton.setActionCommand(""+EDIT);
editButton.addActionListener(this);
}
if (model.canDelete(data)) {
menuButton = new JButton(icons.getIcon(IconManager.UP_DOWN_9_12));
UIUtilities.unifiedButtonLookAndFeel(menuButton);
menuButton.setBackground(UIUtilities.BACKGROUND_COLOR);
menuButton.addMouseListener(new MouseAdapter() {
public void mousePressed(MouseEvent e)
{
showMenu(menuButton, e.getPoint());
}
});
deleteButton = new JMenuItem(icons.getIcon(IconManager.DELETE_12));
deleteButton.setText("Delete");
deleteButton.addActionListener(this);
deleteButton.setActionCommand(""+DELETE);
}
}
/**
* Brings up the menu.
*
* @param invoker The component where the clicks occurred.
* @param p The location of the mouse pressed.
*/
private void showMenu(JComponent invoker, Point p)
{
if (popMenu == null) {
popMenu = new JPopupMenu();
//if (editButton != null) popMenu.add(editButton);
if (deleteButton != null) popMenu.add(deleteButton);
}
popMenu.show(invoker, p.x, p.y);
}
/**
* Builds the tool bar.
*
* @return See above.
*/
private JPanel buildToolBar()
{
controlsBar = new JPanel();
controlsBar.setLayout(new FlowLayout(FlowLayout.LEFT, 0, 0));
String owner = model.formatOwner(data);
String date = model.formatDate(data);
JLabel l = new JLabel(owner+" "+date);
l.setFont(l.getFont().deriveFont(Font.BOLD));
if (menuButton != null) controlsBar.add(menuButton);
controlsBar.add(l);
return controlsBar;
}
/** Builds and lays out the UI. */
private void buildGUI()
{
setLayout(new FlowLayout(FlowLayout.LEFT, 0, 0));
//if (menuButton != null) add(menuButton);
JPanel p = new JPanel();
p.setLayout(new BoxLayout(p, BoxLayout.Y_AXIS));
p.add(buildToolBar());
p.add(area);
add(p);
}
/**
* Creates a new component.
*
* @param uiDelegate Reference to the UI component hosting this
* component.
* @param model Reference to the model.
* Mustn't be <code>null</code>.
* @param data The annotation to handle.
*/
TextualAnnotationComponent(EditorModel model, TextualAnnotationData data)
{
this.data = data;
this.model = model;
initialize();
buildGUI();
}
/**
* Returns the annotation hosted by this component.
*
* @return See above.
*/
TextualAnnotationData getData() { return data; }
/**
* Sets the background of the area, the background color
* will change when the user clicks on the node.
*
* @param color The color to set.
*/
void setAreaColor(Color color)
{
//area.setOriginalBackground(color);
setBackground(color);
Component[] components = getComponents();
for (int i = 0; i < components.length; i++) {
components[i].setBackground(color);
}
controlsBar.setBackground(color);
if (menuButton != null)
menuButton.setBackground(color);
//Color.white
area.setBackground(color);//UIUtilities.BACKGROUND_COLOR);
}
/**
* Deletes or edits the annotation.
* @see ActionListener#actionPerformed(ActionEvent)
*/
public void actionPerformed(ActionEvent e)
{
int index = Integer.parseInt(e.getActionCommand());
switch (index) {
case DELETE:
firePropertyChange(AnnotationUI.REMOVE_ANNOTATION_PROPERTY,
null, this);
break;
case EDIT:
editComment();
}
}
public void propertyChange(PropertyChangeEvent evt) {
String name = evt.getPropertyName();
EventBus bus = MetadataViewerAgent.getRegistry().getEventBus();
if (OMEWikiComponent.WIKI_DATA_OBJECT_PROPERTY.equals(name)) {
WikiDataObject object = (WikiDataObject) evt.getNewValue();
long id = object.getId();
switch (object.getIndex()) {
case WikiDataObject.IMAGE:
if (id > 0) {
ViewImage event = new ViewImage(model.getSecurityContext(),
new ViewImageObject(id), null);
event.setPlugin(MetadataViewerAgent.runAsPlugin());
bus.post(event);
}
}
}
}
}