2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import jalview.bin.Cache;
24 import jalview.bin.Console;
25 import jalview.util.MessageManager;
27 import java.awt.BorderLayout;
28 import java.awt.Component;
29 import java.awt.Dialog.ModalExclusionType;
30 import java.awt.Dimension;
32 import java.awt.Rectangle;
33 import java.awt.event.ActionEvent;
34 import java.awt.event.ActionListener;
35 import java.awt.event.KeyEvent;
36 import java.awt.event.MouseEvent;
37 import java.awt.event.WindowAdapter;
38 import java.awt.event.WindowEvent;
39 import java.beans.PropertyChangeListener;
40 import java.text.DateFormat;
41 import java.text.SimpleDateFormat;
42 import java.util.ArrayList;
43 import java.util.Calendar;
44 import java.util.Collections;
45 import java.util.Date;
46 import java.util.Iterator;
47 import java.util.List;
50 import javax.swing.AbstractAction;
51 import javax.swing.AbstractButton;
52 import javax.swing.Action;
53 import javax.swing.DefaultListCellRenderer;
54 import javax.swing.DefaultListModel;
55 import javax.swing.Icon;
56 import javax.swing.ImageIcon;
57 import javax.swing.JButton;
58 import javax.swing.JFrame;
59 import javax.swing.JLabel;
60 import javax.swing.JList;
61 import javax.swing.JMenuItem;
62 import javax.swing.JPanel;
63 import javax.swing.JPopupMenu;
64 import javax.swing.JScrollPane;
65 import javax.swing.JSplitPane;
66 import javax.swing.JToolBar;
67 import javax.swing.ListSelectionModel;
68 import javax.swing.SwingUtilities;
69 import javax.swing.event.HyperlinkEvent;
70 import javax.swing.event.HyperlinkListener;
71 import javax.swing.event.ListSelectionEvent;
72 import javax.swing.event.ListSelectionListener;
74 import org.robsite.jswingreader.action.MarkChannelAsRead;
75 import org.robsite.jswingreader.action.MarkChannelAsUnread;
76 import org.robsite.jswingreader.action.MarkItemAsRead;
77 import org.robsite.jswingreader.action.MarkItemAsUnread;
78 import org.robsite.jswingreader.action.UpdatableAction;
79 import org.robsite.jswingreader.model.Channel;
80 import org.robsite.jswingreader.model.ChannelListModel;
81 import org.robsite.jswingreader.model.Item;
82 import org.robsite.jswingreader.model.SimpleRSSParser;
83 import org.robsite.jswingreader.ui.BlogContentPane;
84 import org.robsite.jswingreader.ui.ItemReadTimer;
85 import org.robsite.jswingreader.ui.Main;
86 import org.robsite.jswingreader.ui.util.ContextMenuMouseAdapter;
89 * Blog reading window, adapted from JSwingReader's
90 * org.robsite.jswingreader.ui.MainWindow class
93 public class BlogReader extends JPanel
95 private JButton buttonRefresh = new JButton();
97 private JToolBar toolBar = new JToolBar();
99 private JLabel statusBar = new JLabel();
101 private JPanel panelMain = new JPanel();
103 private BorderLayout layoutMain = new BorderLayout();
105 private BorderLayout borderLayout1 = new BorderLayout();
107 private JPanel topPanel = new JPanel();
109 private JPanel bottomPanel = new JPanel();
111 private JSplitPane topBottomSplitPane = new JSplitPane();
113 private JList listItems = new JList(new DefaultListModel());
115 // SWITCH IN JALVIEW HTML VIEWER PANE HERE
116 private BlogContentPane textDescription = new BlogContentPane();
118 // ADD IN JALVIEW BANNER FOR PRETTINESS
119 private BorderLayout borderLayout4 = new BorderLayout();
121 private BorderLayout borderLayout5 = new BorderLayout();
123 private ChannelListModel _channelModel = null;
125 private JList listChannels = new JList();
127 private Action exitAction = new Action()
131 public void actionPerformed(ActionEvent arg0)
141 parent.showNews(false);
147 public void setEnabled(boolean arg0)
153 public void removePropertyChangeListener(PropertyChangeListener arg0)
155 // TODO Auto-generated method stub
160 public void putValue(String arg0, Object arg1)
162 // TODO Auto-generated method stub
167 public boolean isEnabled()
169 // TODO Auto-generated method stub
174 public Object getValue(String arg0)
176 // TODO Auto-generated method stub
181 public void addPropertyChangeListener(PropertyChangeListener arg0)
183 // TODO Auto-generated method stub
188 private JFrame xf = null;
190 private JalviewDialog jd = null;
192 private JalviewDialog createDialog()
195 return jd = new JalviewDialog()
199 protected void raiseClosed()
203 Console.debug("News window closed.");
205 parent.showNews(false);
210 protected void okPressed()
212 // TODO Auto-generated method stub
217 protected void cancelPressed()
219 // TODO Auto-generated method stub
225 private JLabel lblChannels = new JLabel();
227 private List _updatableActions = new ArrayList();
229 private ItemReadTimer _itemTimer = null;
231 private JPopupMenu _popupItems = null;
233 private JPopupMenu _popupChannels = null;
235 private String lastm = "";
237 private boolean newsnew = false;
239 private Desktop parent = null;
246 // should we ignore fake gui events
247 private boolean updating = false;
249 public BlogReader(Desktop desktop)
251 Console.debug("Constructing news reader.");
254 _channelModel = new ChannelListModel();
255 // Construct our jalview news channel
256 Channel chan = new Channel();
258 Cache.getDefault("JALVIEW_NEWS_RSS",
259 Cache.getDefault("www.jalview.org",
260 "https://www.jalview.org")
261 + "/feeds/desktop/rss"));
263 _channelModel.addChannel(chan);
269 } catch (Exception e)
276 boolean setvisible = checkForNew(chan, true);
281 Console.debug("Will show jalview news automatically");
284 Console.debug("Completed construction of reader.");
289 * check if the news panel's container is visible
292 public boolean isVisible()
296 return xf != null && xf.isVisible();
298 return jd != null && jd.isVisible();
302 * display the container for the news panel
304 public void showNews()
306 final BlogReader me = this;
307 SwingUtilities.invokeLater(new Runnable()
312 Rectangle bounds = new Rectangle(5, 5, 550, 350);
316 xf.setContentPane(me);
317 xf.addWindowListener(new WindowAdapter()
320 public void windowClosing(WindowEvent e)
322 ActionEvent actionEvent = new ActionEvent(this,
323 ActionEvent.ACTION_FIRST,
324 (String) exitAction.getValue(Action.NAME));
325 exitAction.actionPerformed(actionEvent);
329 public void windowOpened(WindowEvent e)
333 me.setSize(new Dimension(550, 350));
339 bounds = new Rectangle(5, 5, 550, 350);
340 jd.initDialogFrame(me, false, false,
341 MessageManager.getString("label.news_from_jalview"),
342 bounds.width, bounds.height);
343 jd.frame.setModalExclusionType(ModalExclusionType.NO_EXCLUDE);
344 Console.debug("Displaying news.");
352 * update hasnew flag and mark all new messages as unread.
354 private boolean checkForNew(Channel chan, boolean updateItems)
357 if (!updating || updateItems)
361 java.util.Date earliest = null;
364 earliest = new SimpleDateFormat("YYYY-MM-DD")
365 .parse(chan.getHTTPLastModified());
366 } catch (Exception x)
369 if (chan != null && chan.getItems() != null)
371 Console.debug("Scanning news items: newsnew=" + newsnew
372 + " and lastDate is " + lastDate);
373 for (Item i : (List<Item>) chan.getItems())
375 Date published = i.getPublishDate();
376 boolean isread = lastDate == null ? false
377 : (published != null && !lastDate.before(published));
379 if (!updating || updateItems)
387 if (published != null && !i.isRead())
389 if (earliest == null || earliest.after(published))
391 earliest = published;
396 if (!updateItems && !updating && lastDate == null)
403 java.util.Date lastDate = null;
405 private void loadLastM()
407 lastDate = Cache.getDateProperty("JALVIEW_NEWS_RSS_LASTMODIFIED");
410 private void saveLastM(Item item)
414 if (item.getPublishDate() != null)
416 if (lastDate == null || item.getPublishDate().after(lastDate))
418 lastDate = item.getPublishDate();
422 if (_channelModel.getElementAt(0) != null)
424 checkForNew((Channel) _channelModel.getElementAt(0), false);
426 if (lastDate != null)
428 String formatted = Cache
429 .setDateProperty("JALVIEW_NEWS_RSS_LASTMODIFIED", lastDate);
430 Console.debug("Saved last read date as " + formatted);
435 private void jbInit() throws Exception
437 setLayout(layoutMain);
438 panelMain.setLayout(borderLayout1);
439 topPanel.setLayout(borderLayout5);
440 bottomPanel.setLayout(borderLayout4);
441 topBottomSplitPane.setOrientation(JSplitPane.VERTICAL_SPLIT);
442 topBottomSplitPane.setDividerLocation(100);
443 topBottomSplitPane.setTopComponent(topPanel);
444 topBottomSplitPane.setBottomComponent(bottomPanel);
445 JScrollPane spTextDescription = new JScrollPane(textDescription);
446 textDescription.setText("");
447 statusBar.setText(new StringBuffer("[")
448 .append(MessageManager.getString("label.status")).append("]")
450 buttonRefresh.addActionListener(new ActionListener()
454 public void actionPerformed(ActionEvent e)
459 add(statusBar, BorderLayout.SOUTH);
460 toolBar.add(buttonRefresh);
461 toolBar.addSeparator();
462 JLabel about = new JLabel(
463 "brought to you by JSwingReader (jswingreader.sourceforge.net)");
465 toolBar.setFloatable(false);
466 add(toolBar, BorderLayout.NORTH);
467 panelMain.add(topBottomSplitPane, BorderLayout.CENTER);
468 add(panelMain, BorderLayout.CENTER);
469 JScrollPane spListItems = new JScrollPane(listItems);
471 .setSelectionMode(ListSelectionModel.SINGLE_INTERVAL_SELECTION);
472 topPanel.add(spListItems, BorderLayout.CENTER);
473 bottomPanel.add(spTextDescription, BorderLayout.CENTER);
474 listChannels.setModel(_channelModel);
476 listItems.addMouseListener(new java.awt.event.MouseAdapter()
479 public void mouseClicked(MouseEvent e)
481 listItems_mouseClicked(e);
484 _popupItems = _buildItemsPopupMenu();
485 _popupChannels = _buildChannelsPopupMenu();
486 ContextMenuMouseAdapter popupAdapter = new ContextMenuMouseAdapter(
488 ContextMenuMouseAdapter popupChannelsAdapter = new ContextMenuMouseAdapter(
490 listItems.addMouseListener(popupAdapter);
491 listItems.setCellRenderer(new ItemsRenderer());
492 lblChannels.setText(MessageManager.getString("label.channels"));
495 private void postInit()
497 // clear the default hyperlink listener and replace with our own.
498 for (HyperlinkListener hll : textDescription.getHyperlinkListeners())
500 textDescription.removeHyperlinkListener(hll);
502 textDescription.addHyperlinkListener(new HyperlinkListener()
505 public void hyperlinkUpdate(HyperlinkEvent e)
507 if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED)
509 Desktop.showUrl(e.getURL().toExternalForm());
514 listItems.addListSelectionListener(new ListSelectionListener()
517 public void valueChanged(ListSelectionEvent e)
519 if (e.getValueIsAdjusting() == false)
521 _itemsValueChanged(listItems);
525 listChannels.setSelectedIndex(1);
527 _updateToolbarButtons();
529 _itemTimer = new ItemReadTimer(listChannels, listItems);
530 _itemsValueChanged(listItems);
533 public class LaunchJvBrowserOnItem extends AbstractAction
534 implements UpdatableAction
536 JList _listItems = null;
538 public LaunchJvBrowserOnItem(JList listItems)
540 super("Open in Browser");
541 this.putValue(MNEMONIC_KEY, Integer.valueOf(KeyEvent.VK_O));
542 this.putValue(Action.LONG_DESCRIPTION, "Open in Browser");
543 _listItems = listItems;
547 public void actionPerformed(ActionEvent e)
549 Object o = _listItems.getSelectedValue();
550 if (o instanceof Item)
552 Item item = (Item) o;
554 _listItems.repaint();
556 Desktop.showUrl(item.getLink());
561 public void update(Object o)
564 if (_listItems == null || _listItems.getModel().getSize() == 0)
568 else if (_listItems.getSelectedIndex() == -1)
576 private JPopupMenu _buildItemsPopupMenu()
578 JPopupMenu popup = new JPopupMenu();
579 popup.add(new JMenuItem(new LaunchJvBrowserOnItem(listItems)));
580 popup.addSeparator();
581 popup.add(new JMenuItem(new MarkItemAsRead(listItems)));
582 popup.add(new JMenuItem(new MarkItemAsUnread(listItems)));
586 private JPopupMenu _buildChannelsPopupMenu()
588 JPopupMenu popup = new JPopupMenu();
590 new JMenuItem(new MarkChannelAsRead(listChannels, listItems)));
591 popup.add(new JMenuItem(
592 new MarkChannelAsUnread(listChannels, listItems)));
596 private void initItems(Channel channel)
600 channel = new Channel();
602 if (!channel.isOpen() && channel.getURL() != null)
606 SimpleRSSParser.parse(channel);
607 } catch (Exception ex)
609 ex.printStackTrace();
612 DefaultListModel itemsModel = (DefaultListModel) listItems.getModel();
614 Iterator iter = (channel.getItems() != null)
615 ? channel.getItems().iterator()
616 : Collections.EMPTY_LIST.iterator();
617 while (iter.hasNext())
619 itemsModel.addElement(iter.next());
621 if (itemsModel.getSize() > 0)
623 listItems.setSelectedIndex(0);
624 _itemsValueChanged(listItems);
626 setStatusBarText(channel.getURL());
630 private void _itemsValueChanged(JList itemList)
632 Item item = (Item) itemList.getSelectedValue();
635 if (itemList.getModel().getSize() > 0)
637 item = (Item) itemList.getModel().getElementAt(0);
645 itemList.setSelectedIndex(0);
649 if (_itemTimer != null)
651 // prefer a shorter delay than 5s
652 _itemTimer.setDelay(300);
654 _itemTimer.setLastItem(item);
655 final Item lastitem = item;
656 _itemTimer.addActionListener(new ActionListener()
660 public void actionPerformed(ActionEvent e)
667 setStatusBarText(item.getLink());
668 textDescription.setBlogText(item);
672 public void setStatusBarText(String text)
674 statusBar.setText(text);
677 private void _updateAllActions()
679 Iterator iter = _updatableActions.iterator();
680 while (iter.hasNext())
682 UpdatableAction action = (UpdatableAction) iter.next();
687 private void _updateToolbarButtons()
689 Map general = (Map) Main.getPreferences().get("general");
695 Component[] components = toolBar.getComponents();
696 for (int i = 0; i < components.length; i++)
698 Component component = components[i];
699 if (component instanceof JButton)
701 JButton button = (JButton) component;
702 if (Boolean.toString(false).equals(general.get("useToolBarText")))
704 // Remove the text if preferences state no toolbar text
707 if (Boolean.toString(true).equals(general.get("radioTextBelow")))
709 button.setVerticalTextPosition(AbstractButton.BOTTOM);
710 button.setHorizontalTextPosition(AbstractButton.CENTER);
712 else if (Boolean.toString(true)
713 .equals(general.get("radioTextRight")))
715 button.setVerticalTextPosition(AbstractButton.CENTER);
716 button.setHorizontalTextPosition(AbstractButton.RIGHT);
722 private void listItems_mouseClicked(MouseEvent e)
724 if (e.getClickCount() == 2 && e.getModifiersEx() == MouseEvent.NOBUTTON)
726 Item item = (Item) listItems.getSelectedValue();
729 if (_itemTimer != null)
734 Action action = new LaunchJvBrowserOnItem(listItems);
735 ActionEvent event = new ActionEvent(this,
736 ActionEvent.ACTION_PERFORMED, "LaunchBrowserOnItem");
737 action.actionPerformed(event);
742 * force the news panel to refresh
744 public void refreshNews()
748 initItems((Channel) _channelModel.getElementAt(0));
750 } catch (Exception x)
759 public static void main(String args[])
761 // this tests the detection of new news based on the last read date stored
762 // in jalview properties
763 Cache.loadProperties(null);
764 Console.initLogger();
765 // test will advance read date each time
766 Calendar today = Calendar.getInstance(),
767 lastread = Calendar.getInstance();
768 lastread.set(1983, 01, 01);
769 while (lastread.before(today))
771 String formattedDate = Cache.setDateProperty(
772 "JALVIEW_NEWS_RSS_LASTMODIFIED", lastread.getTime());
773 BlogReader me = new BlogReader();
774 System.out.println("Set last date to " + formattedDate);
777 Console.debug("There is news to read.");
781 Console.debug("There is no new news.");
782 me.xf.setTitle("Testing : Last read is " + me.lastDate);
786 Console.debug("Waiting for closure.");
792 } catch (InterruptedException x)
795 } while (me.isVisible());
799 Console.debug("Still new news after reader displayed.");
801 if (lastread.getTime().before(me.lastDate))
803 Console.debug("The news was read.");
804 lastread.setTime(me.lastDate);
808 lastread.add(Calendar.MONTH, 1);
820 class ChannelsRenderer extends DefaultListCellRenderer
822 private final static Icon _icon = new ImageIcon(
823 Main.class.getResource("image/ComposeMail16.gif"));
826 public Component getListCellRendererComponent(JList list, Object value,
827 int index, boolean isSelected, boolean cellHasFocus)
829 JLabel component = (JLabel) super.getListCellRendererComponent(list,
830 value, index, isSelected, cellHasFocus);
831 component.setIcon(ChannelsRenderer._icon);
832 if (value instanceof Channel)
834 Channel channel = (Channel) value;
835 component.setText(MessageManager
836 .formatMessage("label.channel_title_item_count", new String[]
837 { channel.getTitle(), Integer
838 .valueOf(channel.getUnreadItemCount()).toString() }));
839 component.setToolTipText(channel.getURL());
845 class ItemsRenderer extends DefaultListCellRenderer
847 private final static Icon _icon = new ImageIcon(
848 Main.class.getResource("image/ComposeMail16.gif"));
851 public Component getListCellRendererComponent(JList list, Object value,
852 int index, boolean isSelected, boolean cellHasFocus)
854 JLabel component = (JLabel) super.getListCellRendererComponent(list,
855 value, index, isSelected, cellHasFocus);
856 component.setIcon(ItemsRenderer._icon);
857 if (value instanceof Item)
859 Item item = (Item) value;
860 if (item.getPublishDate() != null)
862 component.setText(MessageManager.formatMessage(
863 "label.blog_item_published_on_date", new String[]
865 .getDateInstance(DateFormat.LONG,
866 MessageManager.getLocale())
867 .format(item.getPublishDate()).toString(),
870 component.setToolTipText(item.getLink());
873 component.setFont(component.getFont().deriveFont(Font.BOLD));
877 component.setFont(component.getFont().deriveFont(Font.PLAIN));