Logo Search packages:      
Sourcecode: josm version File versions  Download package

HelpAction.java

// License: GPL. Copyright 2007 by Immanuel Scholz and others
package org.openstreetmap.josm.actions;

import static org.openstreetmap.josm.tools.I18n.tr;

import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Point;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.io.IOException;
import java.io.StringReader;

import javax.swing.AbstractAction;
import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JEditorPane;
import javax.swing.JFrame;
import javax.swing.JMenu;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.KeyStroke;
import javax.swing.SwingUtilities;
import javax.swing.event.HyperlinkEvent;
import javax.swing.event.HyperlinkListener;

import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.tools.ImageProvider;
import org.openstreetmap.josm.tools.OpenBrowser;
import org.openstreetmap.josm.tools.WikiReader;

/**
 * Open a help browser and displays lightweight online help.
 *
 * @author imi
 */
00042 public class HelpAction extends AbstractAction {

      public interface Helpful {
            String helpTopic();
    }

      private JFrame helpBrowser = new JFrame("JOSM Online Help");
      private String baseurl = Main.pref.get("help.baseurl", "http://josm.openstreetmap.de");
      private JEditorPane help = new JEditorPane();
      private WikiReader reader = new WikiReader(baseurl);
      private String url;

      public HelpAction() {
            super(tr("Help"), ImageProvider.get("help"));
            help.setEditable(false);
            help.addHyperlinkListener(new HyperlinkListener(){
                  public void hyperlinkUpdate(HyperlinkEvent e) {
                        if (e.getEventType() != HyperlinkEvent.EventType.ACTIVATED)
                              return;
                        if (e.getURL() == null)
                              help.setText("<html>404 not found</html>");
                        else if (e.getURL().toString().startsWith(WikiReader.JOSM_EXTERN))
                              OpenBrowser.displayUrl("http://"+e.getURL().toString().substring(WikiReader.JOSM_EXTERN.length())+"?action=edit");
                        else
                              setHelpUrl(e.getURL().toString());
                  }
            });
            help.setContentType("text/html");

            JPanel p = new JPanel(new BorderLayout());
            helpBrowser.setContentPane(p);

            p.add(new JScrollPane(help), BorderLayout.CENTER);
            String[] bounds = Main.pref.get("help.window.bounds", "0,0,800,600").split(",");
            helpBrowser.setBounds(
                        Integer.parseInt(bounds[0]),
                        Integer.parseInt(bounds[1]),
                        Integer.parseInt(bounds[2]),
                        Integer.parseInt(bounds[3]));

            JPanel buttons = new JPanel();
            p.add(buttons, BorderLayout.SOUTH);
            createButton(buttons, "Open in Browser");
            createButton(buttons, "Edit");
            createButton(buttons, "Reload");

            helpBrowser.addWindowListener(new WindowAdapter(){
                  @Override public void windowClosing(WindowEvent e) {
                        closeHelp();
                  }
            });

        help.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "Close");
        help.getActionMap().put("Close", new AbstractAction(){
                  public void actionPerformed(ActionEvent e) {
                        closeHelp();
            }
        });
      }

      public void actionPerformed(ActionEvent e) {
            if ("Open in Browser".equals(e.getActionCommand())) {
                  OpenBrowser.displayUrl(url);
            } else if ("Edit".equals(e.getActionCommand())) {
                  if (!url.startsWith(baseurl)) {
                        JOptionPane.showMessageDialog(Main.parent, tr("Can only edit help pages from JOSM Online Help"));
                        return;
                  }
                  OpenBrowser.displayUrl(url+"?action=edit");
            } else if ("Reload".equals(e.getActionCommand())) {
                  setHelpUrl(url);
            } else if (e.getActionCommand() == null) {
                  String topic = null;
                  Point mouse = Main.parent.getMousePosition();
                  if (mouse != null)
                        topic = contextSensitiveHelp(SwingUtilities.getDeepestComponentAt(Main.parent, mouse.x, mouse.y));
                  if (topic == null) {
                        helpBrowser.setVisible(false);
                        setHelpUrl(baseurl+"/wiki/Help");
                  } else
                        help(topic);
            } else {
                  helpBrowser.setVisible(false);
                  setHelpUrl(baseurl+"/wiki/Help");
            }
      }

      /**
       * @return The topic of the help. <code>null</code> for "don't know"
       */
00132       private String contextSensitiveHelp(Object c) {
            if (c instanceof Helpful)
                  return ((Helpful)c).helpTopic();
            if (c instanceof JMenu)
                  return "Menu/"+((JMenu)c).getText();
            if (c instanceof AbstractButton) {
                  AbstractButton b = (AbstractButton)c;
                  if (b.getClientProperty("help") != null)
                        return (String)b.getClientProperty("help");
                  return contextSensitiveHelp(((AbstractButton)c).getAction());
            }
            if (c instanceof Action)
                  return (String)((Action)c).getValue("help");
            if (c instanceof Component)
                  return contextSensitiveHelp(((Component)c).getParent());
            return null;
    }

      /**
       * Displays the help (or browse on the already open help) to the online page
       * with the given help topic. Use this for larger help descriptions.
       */
00154       public void help(String topic) {
            helpBrowser.setVisible(false);
            setHelpUrl(baseurl+"/wiki/Help/"+topic);
      }

      /**
       * Set the content of the help window to a specific text (in html format)
       * @param url The url this content is the representation of
       */
00163       public void setHelpUrl(String url) {
            this.url = url;
            try {
                  help.read(new StringReader(reader.read(url)), help.getEditorKit().createDefaultDocument());
        } catch (IOException e) {
            help.setText("Error while loading page "+url);
        }
            helpBrowser.setVisible(true);
      }

      /**
       * Closes the help window
       */
00176       public void closeHelp() {
            String bounds = helpBrowser.getX()+","+helpBrowser.getY()+","+helpBrowser.getWidth()+","+helpBrowser.getHeight();
            Main.pref.put("help.window.bounds", bounds);
            helpBrowser.setVisible(false);
      }

      private void createButton(JPanel buttons, String name) {
            JButton b = new JButton(tr(name));
            b.setActionCommand(name);
            b.addActionListener(this);
            buttons.add(b);
      }
}

Generated by  Doxygen 1.6.0   Back to index