/********************************************************************************
* *
* (c) Copyright 2010 Verizon Communications USA and The Open University UK *
* *
* This software is freely distributed in accordance with *
* the GNU Lesser General Public (LGPL) license, version 3 or later *
* as published by the Free Software Foundation. *
* For details see LGPL: http://www.fsf.org/licensing/licenses/lgpl.html *
* and GPL: http://www.fsf.org/licensing/licenses/gpl-3.0.html *
* *
* This software is provided by the copyright holders and contributors "as is" *
* and any express or implied warranties, including, but not limited to, the *
* implied warranties of merchantability and fitness for a particular purpose *
* are disclaimed. In no event shall the copyright owner or contributors be *
* liable for any direct, indirect, incidental, special, exemplary, or *
* consequential damages (including, but not limited to, procurement of *
* substitute goods or services; loss of use, data, or profits; or business *
* interruption) however caused and on any theory of liability, whether in *
* contract, strict liability, or tort (including negligence or otherwise) *
* arising in any way out of the use of this software, even if advised of the *
* possibility of such damage. *
* *
********************************************************************************/
package com.compendium.ui.panels;
import java.awt.Color;
import java.awt.Component;
import java.awt.Font;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.util.Hashtable;
import java.util.Vector;
import javax.swing.DefaultListModel;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JToolTip;
import javax.swing.ListCellRenderer;
import javax.swing.ListSelectionModel;
import javax.swing.border.Border;
import javax.swing.border.EmptyBorder;
import javax.swing.border.LineBorder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.compendium.ProjectCompendium;
import com.compendium.core.CoreUtilities;
import com.compendium.core.datamodel.IModel;
import com.compendium.core.datamodel.NodeSummary;
import com.compendium.core.datamodel.PCSession;
import com.compendium.core.datamodel.View;
import com.compendium.ui.UIList;
import com.compendium.ui.UIListViewFrame;
import com.compendium.ui.UIMapViewFrame;
import com.compendium.ui.UINavList;
import com.compendium.ui.UIUtilities;
import com.compendium.ui.UIViewFrame;
import com.compendium.ui.UIViewPane;
import com.compendium.ui.menus.UIMenuView;
import com.compendium.ui.movie.UIMovieMapViewFrame;
import com.compendium.ui.tags.UITagTreePanel;
/**
* Displays the given node's parent views.
*
* @author Michelle Bachler
*/
public class UIHintNodeViewsPanel extends JPanel {
static final Logger log = LoggerFactory.getLogger(UIHintNodeViewsPanel.class);
/** A list of the parent views for the passed node.*/
protected Vector views = null;
/** A JList object displaying the list of parent views for the passed node.*/
protected UINavList lstViews = null;
/** A reference to the current frame.*/
protected UIViewFrame frame = null;
/** The user Id of the current user */
protected String userID = ""; //$NON-NLS-1$
/** The list of user views.*/
protected Hashtable htUserViews = null;
/** The node the views list if for.*/
protected NodeSummary oNode = null;
/** the current view.*/
protected View currentView = null;
/**
* Constructor. Loads the given node's parent views, and paints them in this panel.
*
* @param NodeSummary node, the node whose parent views to put in this panel in a JTextArea.
* @param int xPos, the x position to draw this panel.
* @param int yPos, the y position to draw this panel.
*/
public UIHintNodeViewsPanel(NodeSummary node, int xPos, int yPos) {
setBorder(new LineBorder(Color.gray, 1));
setLocation(xPos, yPos);
//this.userID = userID;
//JTextArea area = new JTextArea();
//WANT THE TOOLTIP FONT / BACKGROUND
JToolTip tool = new JToolTip();
setBackground(tool.getBackground());
lstViews = new UINavList(new DefaultListModel());
lstViews.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
lstViews.setCellRenderer(new ViewListCellRenderer());
lstViews.setBackground(tool.getBackground());
lstViews.setBorder(null);
Font font = tool.getFont();
int scale = ProjectCompendium.APP.getToolBarManager().getTextZoom();
Font newFont = new Font(font.getName(), font.getStyle(), font.getSize()+ scale);
lstViews.setFont(newFont);
JScrollPane sp = new JScrollPane(lstViews);
sp.setBorder(null);
frame = ProjectCompendium.APP.getCurrentFrame();
currentView = frame.getView();
int count = 0;
JLabel label = null;
try {
views = node.getMultipleViews();
views = CoreUtilities.sortList(views);
IModel model = ProjectCompendium.APP.getModel();
PCSession session = model.getSession();
htUserViews = ProjectCompendium.APP.getModel().getUserViews();
oNode = node;
count = views.size();
String sViewID = ""; //$NON-NLS-1$
for(int i=0; i < count; i++) {
final View view = (View)views.elementAt(i);
sViewID = view.getId();
view.initialize(session, model);
String text = view.getLabel();
text = text.trim();
if (text.equals("")) { //$NON-NLS-1$
text = "-- Unlabelled View --"; //$NON-NLS-1$
}
String htmlText = text;
if (htUserViews.containsKey(sViewID)) {
if (sViewID.equals(ProjectCompendium.APP.getInBoxID())) {
htmlText = "<html><u>"+text+" - "+htUserViews.get(sViewID)+"</u></html>"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
} else {
htmlText = text + " - " + htUserViews.get(sViewID); //$NON-NLS-1$
}
}
else {
if (!currentView.getId().equals(sViewID)) {
htmlText = "<html><u>"+text+"</u></html>"; //$NON-NLS-1$ //$NON-NLS-2$
}
}
label = new JLabel(htmlText);
label.setBackground(tool.getBackground());
label.setForeground(tool.getForeground());
label.setFont(newFont);
((DefaultListModel)lstViews.getModel()).addElement(label);
}
}
catch(Exception ex) {
log.info("Error: (UIHintNodeViewsPanel) "+ex.getMessage()); //$NON-NLS-1$
}
if (count <= 20) {
lstViews.setVisibleRowCount(count);
}
else {
lstViews.setVisibleRowCount(20);
}
lstViews.addMouseListener(createMouseListener());
add(sp);
setSize(getPreferredSize());
validate();
}
/**
* The mouse listener for the view selection and exiting behaviours.
* @return a mouse listener.
*/
protected MouseListener createMouseListener() {
MouseListener mouse = new MouseAdapter() {
public void mouseClicked(MouseEvent e) {
int index = lstViews.locationToIndex( e.getPoint());
String id = ""; //$NON-NLS-1$
View view = (View)views.elementAt(index);
id = view.getId();
if ( !id.equals(currentView.getId())) {
if (!htUserViews.containsKey(view.getId())
|| id.equals(ProjectCompendium.APP.getInBoxID())) {
if (frame instanceof UIMovieMapViewFrame) {
UIMovieMapViewFrame mapframe = (UIMovieMapViewFrame)frame;
mapframe.stopTimeLine();
}
UIViewFrame oUIViewFrame = ProjectCompendium.APP.addViewToDesktop(view, view.getLabel());
oUIViewFrame.setNavigationHistory(frame.getChildNavigationHistory());
UIUtilities.focusNodeAndScroll(oNode, oUIViewFrame);
if (frame instanceof UIMapViewFrame) {
UIViewPane pane = ((UIMapViewFrame)frame).getViewPane();
pane.hideViews();
} else {
UIList list = ((UIListViewFrame)frame).getUIList();
list.hideHint();
}
}
}
}
public void mouseExited(MouseEvent evt) {
if (frame instanceof UIMapViewFrame) {
UIViewPane pane = ((UIMapViewFrame)frame).getViewPane();
pane.hideViews();
} else {
UIList list = ((UIListViewFrame)frame).getUIList();
list.hideHint();
}
UITagTreePanel tagTreePanel = UIMenuView.getTagTreePanel();
if (tagTreePanel != null) {
tagTreePanel.hideHint();
}
}
};
return mouse;
}
/**
* Helper class to render the element in the views list.
*/
public class ViewListCellRenderer implements ListCellRenderer {
protected Border noFocusBorder;
/*
* Constructors
*/
public ViewListCellRenderer() {
noFocusBorder = new EmptyBorder(1, 1, 1, 1);
}
public Component getListCellRendererComponent(JList list,
Object value, // value to display
int index, // cell index
boolean isSelected, // is the cell selected
boolean cellHasFocus ) { // the list and the cell have the focus
JLabel lbl = (JLabel)value;
JToolTip tool = new JToolTip();
lbl.setOpaque(true);
lbl.setBorder(null);
return lbl;
}
}
}