-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
Help.java
205 lines (177 loc) · 6.35 KB
/
Help.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
* Help.java
*
* Copyright (C) 2009-12 by RStudio, Inc.
*
* This program is licensed to you under the terms of version 3 of the
* GNU Affero General Public License. This program is distributed WITHOUT
* ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
* AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
*
*/
package org.rstudio.studio.client.workbench.views.help;
import com.google.gwt.event.logical.shared.HasSelectionHandlers;
import com.google.gwt.event.logical.shared.SelectionEvent;
import com.google.gwt.event.logical.shared.SelectionHandler;
import com.google.inject.Inject;
import org.rstudio.core.client.CsvReader;
import org.rstudio.core.client.CsvWriter;
import org.rstudio.core.client.command.CommandBinder;
import org.rstudio.core.client.command.Handler;
import org.rstudio.studio.client.workbench.WorkbenchList;
import org.rstudio.studio.client.workbench.WorkbenchListManager;
import org.rstudio.studio.client.workbench.WorkbenchView;
import org.rstudio.studio.client.workbench.commands.Commands;
import org.rstudio.studio.client.workbench.events.ListChangedEvent;
import org.rstudio.studio.client.workbench.events.ListChangedHandler;
import org.rstudio.studio.client.workbench.views.BasePresenter;
import org.rstudio.studio.client.workbench.views.help.events.*;
import org.rstudio.studio.client.workbench.views.help.model.HelpServerOperations;
import org.rstudio.studio.client.workbench.views.help.model.Link;
import java.util.ArrayList;
import java.util.Iterator;
public class Help extends BasePresenter implements ShowHelpHandler
{
public interface Binder extends CommandBinder<Commands, Help> {}
public interface Display extends WorkbenchView,
HasHelpNavigateHandlers
{
String getUrl() ;
String getDocTitle() ;
void showHelp(String helpURL);
void back() ;
void forward() ;
void print() ;
void popout() ;
void refresh() ;
void focus();
LinkMenu getHistory() ;
/**
* Returns true if this Help pane has ever been navigated.
*/
boolean navigated();
}
public interface LinkMenu extends HasSelectionHandlers<String>
{
void addLink(Link link) ;
void removeLink(Link link) ;
boolean containsLink(Link link) ;
void clearLinks() ;
ArrayList<Link> getLinks() ;
}
@Inject
public Help(Display view,
HelpServerOperations server,
WorkbenchListManager listManager,
Commands commands,
Binder binder)
{
super(view);
server_ = server ;
helpHistoryList_ = listManager.getHelpHistoryList();
view_ = view;
binder.bind(commands, this);
view_.addHelpNavigateHandler(new HelpNavigateHandler() {
public void onNavigate(HelpNavigateEvent event)
{
if (!historyInitialized_)
return;
CsvWriter csvWriter = new CsvWriter();
csvWriter.writeValue(getApplicationRelativeHelpUrl(event.getUrl()));
csvWriter.writeValue(event.getTitle());
helpHistoryList_.append(csvWriter.getValue());
}
}) ;
SelectionHandler<String> navigator = new SelectionHandler<String>() {
public void onSelection(SelectionEvent<String> event)
{
showHelp(event.getSelectedItem()) ;
}
} ;
view_.getHistory().addSelectionHandler(navigator) ;
// initialize help history
helpHistoryList_.addListChangedHandler(new ListChangedHandler() {
@Override
public void onListChanged(ListChangedEvent event)
{
// clear existing
final LinkMenu history = view_.getHistory() ;
history.clearLinks();
// intialize from the list
ArrayList<String> list = event.getList();
for (int i=0; i<list.size(); i++)
{
// parse the two fields out
CsvReader csvReader = new CsvReader(list.get(i));
Iterator<String[]> it = csvReader.iterator();
if (!it.hasNext())
continue;
String[] fields = it.next();
if (fields.length != 2)
continue;
// add the link
Link link = new Link(fields[0], fields[1]);
history.addLink(link);
}
// one time init
if (!historyInitialized_)
{
// mark us initialized
historyInitialized_ = true ;
if (!view_.navigated())
{
ArrayList<Link> links = history.getLinks();
if (links.size() > 0)
showHelp(links.get(0).getUrl());
else
home();
}
}
}
});
}
// Home handled by Shim for activation from main menu context
public void onHelpHome() { view_.bringToFront(); home(); }
@Handler public void onHelpBack() { view_.back(); }
@Handler public void onHelpForward() { view_.forward(); }
@Handler public void onPrintHelp() { view_.print(); }
@Handler public void onHelpPopout() { view_.popout(); }
@Handler public void onRefreshHelp() { view_.refresh(); }
@Handler
public void onClearHelpHistory()
{
if (!historyInitialized_)
return;
helpHistoryList_.clear();
}
public void onShowHelp(ShowHelpEvent event)
{
showHelp(event.getTopicUrl());
view_.bringToFront();
}
private void home()
{
showHelp("help/doc/html/index.html");
}
public Display getDisplay()
{
return view_ ;
}
private void showHelp(String topicUrl)
{
view_.showHelp(server_.getApplicationURL(topicUrl));
}
private String getApplicationRelativeHelpUrl(String helpUrl)
{
String appUrl = server_.getApplicationURL("");
if (helpUrl.startsWith(appUrl) && !helpUrl.equals(appUrl))
return helpUrl.substring(appUrl.length());
else
return helpUrl;
}
private Display view_ ;
private HelpServerOperations server_ ;
private WorkbenchList helpHistoryList_;
private boolean historyInitialized_ ;
}