1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.gui.help;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
5 |
|
---|
6 | import java.awt.BorderLayout;
|
---|
7 | import java.awt.Dimension;
|
---|
8 | import java.awt.event.ActionEvent;
|
---|
9 | import java.awt.event.KeyEvent;
|
---|
10 | import java.awt.event.WindowAdapter;
|
---|
11 | import java.awt.event.WindowEvent;
|
---|
12 | import java.io.IOException;
|
---|
13 |
|
---|
14 | import javax.swing.AbstractAction;
|
---|
15 | import javax.swing.JComponent;
|
---|
16 | import javax.swing.JEditorPane;
|
---|
17 | import javax.swing.JFrame;
|
---|
18 | import javax.swing.JOptionPane;
|
---|
19 | import javax.swing.JPanel;
|
---|
20 | import javax.swing.JScrollPane;
|
---|
21 | import javax.swing.KeyStroke;
|
---|
22 | import javax.swing.event.HyperlinkEvent;
|
---|
23 | import javax.swing.event.HyperlinkListener;
|
---|
24 |
|
---|
25 | import org.openstreetmap.josm.Main;
|
---|
26 | import org.openstreetmap.josm.gui.SideButton;
|
---|
27 | import org.openstreetmap.josm.tools.ImageProvider;
|
---|
28 | import org.openstreetmap.josm.tools.LanguageInfo;
|
---|
29 | import org.openstreetmap.josm.tools.OpenBrowser;
|
---|
30 | import org.openstreetmap.josm.tools.WikiReader;
|
---|
31 | import org.openstreetmap.josm.tools.WindowGeometry;
|
---|
32 |
|
---|
33 | public class HelpBrowser extends JFrame {
|
---|
34 |
|
---|
35 | private JEditorPane help;
|
---|
36 |
|
---|
37 | /** the currently displayed URL */
|
---|
38 | private String url;
|
---|
39 |
|
---|
40 | private String languageCode = LanguageInfo.getLanguageCodeWiki();
|
---|
41 | private String baseurl = Main.pref.get("help.baseurl", "http://josm.openstreetmap.de");
|
---|
42 | private String pathbase = Main.pref.get("help.pathbase", "/wiki/");
|
---|
43 | private WikiReader reader = new WikiReader(baseurl);
|
---|
44 |
|
---|
45 |
|
---|
46 | protected void build() {
|
---|
47 | help = new JEditorPane();
|
---|
48 | help.setEditable(false);
|
---|
49 | help.addHyperlinkListener(new HyperlinkListener(){
|
---|
50 | public void hyperlinkUpdate(HyperlinkEvent e) {
|
---|
51 | if (e.getEventType() != HyperlinkEvent.EventType.ACTIVATED)
|
---|
52 | return;
|
---|
53 | if (e.getURL() == null) {
|
---|
54 | help.setText("<html>404 not found</html>");
|
---|
55 | } else if (e.getURL().toString().endsWith("action=edit")) {
|
---|
56 | OpenBrowser.displayUrl(e.getURL().toString());
|
---|
57 | } else {
|
---|
58 | setUrl(e.getURL().toString());
|
---|
59 | }
|
---|
60 | }
|
---|
61 | });
|
---|
62 | help.setContentType("text/html");
|
---|
63 |
|
---|
64 | JPanel p = new JPanel(new BorderLayout());
|
---|
65 | setContentPane(p);
|
---|
66 |
|
---|
67 | p.add(new JScrollPane(help), BorderLayout.CENTER);
|
---|
68 |
|
---|
69 | JPanel buttons = new JPanel();
|
---|
70 | p.add(buttons, BorderLayout.SOUTH);
|
---|
71 |
|
---|
72 | buttons.add(new SideButton(new OpenInBrowserAction()));
|
---|
73 | buttons.add(new SideButton(new EditAction()));
|
---|
74 | buttons.add(new SideButton(new ReloadAction()));
|
---|
75 |
|
---|
76 | addWindowListener(new WindowAdapter(){
|
---|
77 | @Override public void windowClosing(WindowEvent e) {
|
---|
78 | setVisible(false);
|
---|
79 | }
|
---|
80 | });
|
---|
81 |
|
---|
82 | help.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "Close");
|
---|
83 | help.getActionMap().put("Close", new AbstractAction(){
|
---|
84 | public void actionPerformed(ActionEvent e) {
|
---|
85 | setVisible(false);
|
---|
86 | }
|
---|
87 | });
|
---|
88 |
|
---|
89 | setTitle(tr("JOSM Help Browser"));
|
---|
90 | }
|
---|
91 |
|
---|
92 | public HelpBrowser() {
|
---|
93 | build();
|
---|
94 | }
|
---|
95 |
|
---|
96 | @Override
|
---|
97 | public void setVisible(boolean visible) {
|
---|
98 | if (visible) {
|
---|
99 | new WindowGeometry(
|
---|
100 | getClass().getName() + ".geometry",
|
---|
101 | WindowGeometry.centerInWindow(
|
---|
102 | Main.parent,
|
---|
103 | new Dimension(800,600)
|
---|
104 | )
|
---|
105 | ).applySafe(this);
|
---|
106 | } else if (!visible && isShowing()){
|
---|
107 | new WindowGeometry(this).remember(getClass().getName() + ".geometry");
|
---|
108 | }
|
---|
109 | super.setVisible(visible);
|
---|
110 | }
|
---|
111 |
|
---|
112 | public String getUrl() {
|
---|
113 | return url;
|
---|
114 | }
|
---|
115 |
|
---|
116 | public void setUrl(String url) {
|
---|
117 | String langurl = url;
|
---|
118 | if(url.startsWith(baseurl+pathbase)){
|
---|
119 | int i = pathbase.length()+baseurl.length();
|
---|
120 | String title = url.substring(i);
|
---|
121 | if(languageCode.length() != 0 && !title.startsWith(languageCode)) {
|
---|
122 | title = languageCode + title;
|
---|
123 | }
|
---|
124 | langurl = url.substring(0, i) + title;
|
---|
125 | }
|
---|
126 | boolean loaded = false;
|
---|
127 | if(!langurl.equals(this.url) && !langurl.equals(url)){
|
---|
128 | loaded = loadHelpUrl(url, langurl, true);
|
---|
129 | }
|
---|
130 | if(!loaded) {
|
---|
131 | loaded = loadHelpUrl(url, langurl, false);
|
---|
132 | }
|
---|
133 | if(!loaded) {
|
---|
134 | help.setText(tr("Error while loading page {0}",url));
|
---|
135 | }
|
---|
136 | if (!isVisible()) {
|
---|
137 | setVisible(true);
|
---|
138 | toFront();
|
---|
139 | } else {
|
---|
140 | toFront();
|
---|
141 | }
|
---|
142 | }
|
---|
143 |
|
---|
144 | public void setUrlForHelpTopic(String topic) {
|
---|
145 | setUrl(baseurl+pathbase+ topic);
|
---|
146 | }
|
---|
147 |
|
---|
148 | protected boolean loadHelpUrl(String url, String localizedUrl, boolean useLocalizedUrl){
|
---|
149 | this.url = useLocalizedUrl ? localizedUrl : url;
|
---|
150 | boolean loaded = false;
|
---|
151 | try {
|
---|
152 | String txt = reader.read(this.url);
|
---|
153 | if(txt.length() == 0){
|
---|
154 | if(useLocalizedUrl)
|
---|
155 | throw new IOException();
|
---|
156 | if(url.equals(localizedUrl)){
|
---|
157 | txt = ("<HTML>"+tr("Help page missing. Create it in <A HREF=\"{0}\">English</A>.",
|
---|
158 | url+"?action=edit")+"</HTML>");
|
---|
159 | } else{
|
---|
160 | txt = ("<HTML>"+tr("Help page missing. Create it in <A HREF=\"{0}\">English</A> or <A HREF=\"{1}\">your language</A>.",
|
---|
161 | url+"?action=edit", localizedUrl+"?action=edit")+"</HTML>");
|
---|
162 | }
|
---|
163 | }
|
---|
164 | help.setText(txt);
|
---|
165 | help.setCaretPosition(0);
|
---|
166 | loaded = true;
|
---|
167 | } catch (IOException ex) {
|
---|
168 | }
|
---|
169 | return loaded;
|
---|
170 | }
|
---|
171 |
|
---|
172 | class OpenInBrowserAction extends AbstractAction {
|
---|
173 | public OpenInBrowserAction() {
|
---|
174 | putValue(NAME, tr("Open in Browser"));
|
---|
175 | putValue(SHORT_DESCRIPTION, tr("Open the current help page in an external browser"));
|
---|
176 | // provide icon
|
---|
177 | }
|
---|
178 |
|
---|
179 | public void actionPerformed(ActionEvent e) {
|
---|
180 | OpenBrowser.displayUrl(getUrl());
|
---|
181 | }
|
---|
182 | }
|
---|
183 |
|
---|
184 | class EditAction extends AbstractAction {
|
---|
185 | public EditAction() {
|
---|
186 | putValue(NAME, tr("Edit"));
|
---|
187 | putValue(SHORT_DESCRIPTION, tr("Edit the current help page"));
|
---|
188 | putValue(SMALL_ICON,ImageProvider.get("dialogs", "edit"));
|
---|
189 | }
|
---|
190 |
|
---|
191 | public void actionPerformed(ActionEvent e) {
|
---|
192 | if (!getUrl().startsWith(baseurl)) {
|
---|
193 | JOptionPane.showMessageDialog(
|
---|
194 | Main.parent,
|
---|
195 | tr("Can only edit help pages from JOSM Online Help"),
|
---|
196 | tr("Warning"),
|
---|
197 | JOptionPane.WARNING_MESSAGE
|
---|
198 | );
|
---|
199 | return;
|
---|
200 | }
|
---|
201 | OpenBrowser.displayUrl(url+"?action=edit");
|
---|
202 | }
|
---|
203 | }
|
---|
204 |
|
---|
205 | class ReloadAction extends AbstractAction {
|
---|
206 | public ReloadAction() {
|
---|
207 | putValue(NAME, tr("Reload"));
|
---|
208 | putValue(SHORT_DESCRIPTION, tr("Reload the current help page"));
|
---|
209 | putValue(SMALL_ICON, ImageProvider.get("dialogs", "refresh"));
|
---|
210 | }
|
---|
211 |
|
---|
212 | public void actionPerformed(ActionEvent e) {
|
---|
213 | setUrl(url);
|
---|
214 | }
|
---|
215 | }
|
---|
216 | }
|
---|