This repository was archived by the owner on Jan 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathHelpBroker.java
More file actions
386 lines (348 loc) · 13 KB
/
HelpBroker.java
File metadata and controls
386 lines (348 loc) · 13 KB
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/*
* @(#)HelpBroker.java 1.31 06/10/30
*
* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
package javax.help;
import java.util.Enumeration;
import java.net.URL;
import java.awt.Component;
import java.awt.MenuItem;
import java.awt.event.ActionListener;
import java.awt.Point;
import java.awt.Font;
import java.awt.Dimension;
import javax.help.Map.ID;
import java.util.Locale;
/**
* The HelpBroker is the default presentation of a HelpSet.
*
* A HelpBroker is an abstraction of the presentation for a HelpSet;
* a straight-forward implementation is a JHelp() on the HelpSet.
*
* A HelpBroker can be asked to show a given Navigational View,
* and can display a given ID (help topic).
*
* @author Eduardo Pelegri-Llopart
* @author Roger D.Brinkley
* @version 1.31 10/30/06
*
* @see javax.help.HelpSet
* @see javax.help.JHelpNavigator
* @see javax.help.HelpVisitListener
*/
public interface HelpBroker {
/**
* Sets the current HelpSet for this HelpBroker.
*
* @param hs The HelpSet this JavaHelp is presenting.
*/
public void setHelpSet(HelpSet hs);
/**
* Gets the current HelpSet for this JavaHelp object.
*
* @return The HelpSet this JavaHelp is presenting.
*/
public HelpSet getHelpSet();
/**
* Sets the presentation attributes from a HelpSet.Presentation.
* The HelpSet.Presentation must be in the current HelpSet.
*
* @param hsPres The HelpSet.Presentation
* @since 2.0
*/
public void setHelpSetPresentation(HelpSet.Presentation hsPres);
/**
* Returns the locale of this object.
*
* @return The locale of this object.
*/
public Locale getLocale();
/**
* Sets the locale of this HelpBroker.
* @param l The locale to become this component's locale.
* @see #getLocale
*/
public void setLocale(Locale l);
/**
* Gets the font for this HelpBroker.
*/
public Font getFont();
/**
* Sets the font for this HelpBroker.
*
*/
public void setFont(Font f);
/**
* Activates the Navigator view with a given name.
*
* @exception IllegalArgumentException if the name is not valid.
*/
public void setCurrentView(String name);
/**
* Gets name of the current navigational view.
*
* @return The name of the current navigational view.
*/
public String getCurrentView();
/**
* Initializes the presentation.
* This method allows the presentation to be initialized but not displayed.
* Typically this is done in a separate thread to reduce the
* intialization time.
*/
public void initPresentation();
/**
* Displays the presentation to the user.
*
* @param displayed Makes the presentation visible or not.
* @exception HelpBroker.UnsupportedOperationException If the operation is not supported.
*/
public void setDisplayed(boolean displayed) throws UnsupportedOperationException;
/**
* Determines if the presentation is visible.
*
* @return Whether the presentation is currently visible.
*/
public boolean isDisplayed();
/**
* Sets the position of the presentation.
* This operation may throw an UnsupportedOperationException if the
* underlying implementation does not allow this.
*/
public void setLocation(Point p) throws UnsupportedOperationException;
/**
* Gets the location of the presentation.
* This operation may throw an UnsupportedOperationException if the
* underlying implementation does not allow this.
*/
public Point getLocation() throws UnsupportedOperationException;
/**
* Sets the size of the presentation.
* This operation may throw an UnsupportedOperationException if the
* underlying implementation does not allow this.
*/
public void setSize(Dimension d) throws UnsupportedOperationException;
/**
* Gets the size of the presentation.
* This operation may throw an UnsupportedOperationException if the
* underlying implementation does not allow this.
*/
public Dimension getSize() throws UnsupportedOperationException;
/**
* Set the screen the presentation is to be displayed on
* This operation may throw an UnsupportedOperationException if the
* underlying implementation does not allow this.
*/
public void setScreen(int screen) throws UnsupportedOperationException;
/**
* Get ths the screen the presentation is displayed on
* This operation may throw an UnsupportedOperationException if the
* underlying implementation does not allow this.
*/
public int getScreen() throws UnsupportedOperationException;
/**
* Hides/Shows Navigational Views.
*
* @param displayed Make the navigational views visible or not.
*/
public void setViewDisplayed(boolean displayed);
/**
* Determines if the Navigational View is visible.
*
* @return Whether the navigational views are visible.
*/
public boolean isViewDisplayed();
/**
* Displays this ID in a given presentation
*
* @param id An ID that identifies the topic to display.
* @param presentation The Presentation class to display the Help in.
* @param presentationName The name of a Presentation section from a
* HelpSet to use. For some Presentations this will also be
* the name to apply to the Presentation.
* @exception InvalidHelpSetContextException If id.hs is not contanied in the current
* HelpSet of this broker.
* @see Presentation
*/
public void showID(ID id, String presentation, String presentationName)
throws InvalidHelpSetContextException;
/**
* Displays this ID in a particular presentation
*
* @param id A String identifying the topic to show relative to getHelpSet()
* @param presentation The Presentation class to display the Help in.
* @param presentationName The name of a Presentation section from a
* HelpSet to use. For some Presentations this will also be
* the name to apply to the Presentation.
* @exception BadIDException if the ID is not valid in the map.
* @see Presentation
*/
public void showID(String id, String presentation, String presentationName)
throws BadIDException;
/**
* Displays this ID.
*
* @param id An ID that identifies the topic to display.
* @exception InvalidHelpSetContextException If id.hs is not contanied in the current
* HelpSet of this broker.
* @see HelpModel#setCurrentID
*/
public void setCurrentID(ID id) throws InvalidHelpSetContextException;
/**
* Displays this ID.
* HelpVisitListeners are notified.
*
* @param id A String identifying the topic to show relative to getHelpSet()
* @exception BadIDException if the ID is not valid in the map.
*/
public void setCurrentID(String id) throws BadIDException;
/**
* Determines The currently displayed ID (if any).
*
* @return The ID being shown.
*/
public ID getCurrentID();
/**
* Displays this ID.
* HelpVisitListeners are notified.
* The currentID changes if there is a matching ID for this URL.
*
* @param url The URL to show
*/
public void setCurrentURL(URL url);
/**
* Determines the currently displayed ID.
*
* @return The URL being shown.
*/
public URL getCurrentURL();
/**
* Enables the Help key on a component. This method works best when
* the component is the
* rootPane of a JFrame in Swing implementations, or a java.awt.Window
* (or subclass thereof) in AWT implementations.
* This method sets the default
* helpID and HelpSet for the component and registers keyboard actions
* to trap the "Help" keypress. When the "Help" key is pressed, if the
* object with the current focus has a helpID, the helpID is displayed,
* otherwise the default helpID is displayed.
*
* @param comp The component to enable the keyboard actions on.
* @param id The default HelpID to be displayed.
* @param hs The default HelpSet to be displayed.
*/
public void enableHelpKey(Component comp, String id, HelpSet hs);
/**
* Enables the Help key on a component. This method works best when
* the component is the
* rootPane of a JFrame in Swing implementations, or a java.awt.Window
* (or subclass thereof) in AWT implementations.
* This method sets the default
* helpID and HelpSet for the component and registers keyboard actions
* to trap the "Help" keypress. When the "Help" key is pressed, if the
* object with the current focus has a helpID, the helpID is displayed,
* otherwise the default helpID is displayed.
*
* @param comp The component to enable the keyboard actions on.
* @param id The default HelpID to be displayed.
* @param hs The default HelpSet to be displayed.
* @param presentation The Presentation class to display the Help in.
* @param presentationName The name of a Presentation section from a
* HelpSet to use. For some Presentations this will also be
* the name to apply to the Presentation.
* @see Presentation
*/
public void enableHelpKey(Component comp, String id, HelpSet hs,
String presentation, String presentationName);
/**
* Enables help for a component. This method sets a
* component's helpID and HelpSet.
*
* @see CSH.setHelpID
* @see CSH.setHelpSet
*/
public void enableHelp(Component comp, String id, HelpSet hs);
/**
* Enables help for a MenuItem. This method sets a
* component's helpID and HelpSet.
*
* @see CSH.setHelpID
* @see CSH.setHelpSet
*/
public void enableHelp(MenuItem comp, String id, HelpSet hs);
/**
* Enables help for a component. This method sets a
* component's helpID and HelpSet and adds an ActionListener.
* When an action is performed
* it displays the component's helpID and HelpSet in the default viewer.
* If the component is not a javax.swing.AbstractButton or a
* java.awt.Button an IllegalArgumentException is thrown.
*
* @see CSH.setHelpID
* @see CSH.setHelpSet
* @see javax.swing.AbstractButton
* @see java.awt.Button
*/
public void enableHelpOnButton(Component comp, String id, HelpSet hs)
throws IllegalArgumentException;
/**
* Enables help for a MenuItem. This method sets a
* component's helpID and HelpSet and adds an ActionListener.
* When an action is performed
* it displays the component's helpID and HelpSet in the default viewer.
*
* @see CSH.setHelpID
* @see CSH.setHelpSet
* @see java.awt.MenuItem
*/
public void enableHelpOnButton(MenuItem comp, String id, HelpSet hs);
/**
* Enables help for an object. This method sets a
* object's helpID and HelpSet and adds an ActionListener.
* When an action is performed
* it displays the component's helpID and HelpSet in the default viewer
* or the presenation if defined.
* If the component is not a javax.swing.AbstractButton or a
* java.awt.Button an IllegalArgumentException is thrown.
*
* @param comp The component to enable the keyboard actions on.
* @param id The default HelpID to be displayed.
* @param hs The default HelpSet to be displayed.
* @param presentation The Presentation class to display the Help in.
* @param presentationName The name of a Presentation section from a
* HelpSet to use. For some Presentations this will also be
* the name to apply to the Presentation.
*
* @see Presentation
* @see CSH.setHelpID
* @see CSH.setHelpSet
* @see javax.swing.AbstractButton
* @see java.awt.Button
*/
public void enableHelpOnButton(Object obj, String id, HelpSet hs,
String presentation,
String presentationName)
throws IllegalArgumentException;
}