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 pathserverhlp.html
More file actions
589 lines (583 loc) · 25.2 KB
/
serverhlp.html
File metadata and controls
589 lines (583 loc) · 25.2 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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--
* Copyright © 2003 Sun Microsystems, Inc
* All rights reserved.
* Notice of copyright on this source code
* product does not indicate publication.
*
* RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by
* the U.S. Government is subject to restrictions as set forth
* in subparagraph (c)(1)(ii) of the Rights in Technical Data
* and Computer Software Clause at DFARS 252.227-7013 (Oct. 1988)
* and FAR 52.227-19 (c) (June 1987).
* Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A.
*
-->
<html>
<head>
<title>Server Based JavaHelp</title>
<link rel="stylesheet" type="text/css" href="../jhug.css" title="Style">
</head>
<body bgcolor="#ffffff">
<h2>Server-Based JavaHelp Helpsets</h2>
<p> Server-based applications have the same need for online help as client based
applications, but they require that the helpset runs in a web browser, as the applications
do, and that it be accessed from a server. Version 1.0 of the JavaHelp software API provided a
foundation for developing online help for server-based applications. However,
the specification did not define standards for a JavaHelp bean or for a Java
Server Pages<sup>TM</sup> (JSP) tag library to access helpset data. Version 2 of the JavaHelp
software does define these standards and provides a tag library for server-based applications.
<h3>Java Server Pages</h3>
<p>JSP enables web developers to develop dynamic web pages. JSP uses XML-like
tags to encapsulate the logic that generates web content. JSP pages separate
the page logic from its design and display, which prevents the overlapping of
roles between web designers and programmers. Designers design the web pages
and programmers add the logic and code to them. </p>
<p>For more information and tutorials on JavaServer Pages technology, see <a href="http://java.sun.com/products/jsp/docs.html">http://java.sun.com/products/jsp/docs.html</a>.</p>
<h3>Server-Based JavaHelp Architecture</h3>
<p>By combining the JavaHelp software API with new JavaHelp JSP tag libraries,
web developers are now able to provide help for server-based applications. The
diagram below illustrates the architecture.</p>
<p align="center"><img src="../images/serverarch.gif" width="454" height="203">.</p>
<p align="left">A browser initiates a JSP request. Examples of a JSP request are
displaying the help content in the helpset, the navigators, or the data for
a given navigator. Typically, the JSP request contains JavaBeans<sup>TM</sup>
components as well as JSP tag extensions. The Java<sup>TM</sup>
server turns the request into a Java Servlet. The servlet access the appropriate
information from the helpset by using the classes in the JavaHelp library (<code>jh.jar</code>)
and the JavaHelp tag library (<code>jhtags.jar</code>) and returns HTML and possibly
JavaScript or dynamic HTML (DHTML) to the browser.</p>
<h3 align="left">JavaHelp Server Components</h3>
<p align="left">Access to helpset data on a server is accomplished through a combination
of JavaBeans components specific to the JavaHelp system and JSP tag extensions.
This section defines the standard JavaHelp JavaBeans and JSP tag extensions
and scripting variables.</p>
<h4 align="left"><a name="ServletHelpBroker">JavaHelp Server Bean</a></h4>
<p align="left"><code>ServletHelpBroker</code> is the JavaBean component that stores
help state information, such as the helpset in use, the current ID, the current
navigator and other pieces of help information. While it implements the <code>javax.help.HelpBroker</code>
interface, some of the methods are either not implemented or throw <code>UnsupportedOperationExceptions</code>
if called. The <code>javax.help.HelpBroker</code> methods that are not implemented
in this component are listed below:</p>
<p align="left"> </p>
<table border="1" cellspacing="0" cellpadding="5">
<tr valign="top">
<th>
<div align="left">Method</div>
</th>
<th>
<div align="left">Result</div>
</th>
</tr>
<tr valign="top">
<td><code>initPresentation()</code></td>
<td>No Operation</td>
</tr>
<tr valign="top">
<td><code>setDisplayed(boolean)</code></td>
<td>Ignored</td>
</tr>
<tr valign="top">
<td><code>boolean isDisplayed()</code></td>
<td>Always returns true</td>
</tr>
<tr valign="top">
<td><code>enableHelpKey(<br>
Component,<br>
String id, HelpSet)</code></td>
<td>No Operation</td>
</tr>
<tr valign="top">
<td><code>enableHelp(<br>
Component|MenuItem,<br>
String id, HelpSet)</code></td>
<td>No Operation</td>
</tr>
<tr valign="top">
<td><code>enableHelpOnButton(<br>
Component| MenuItem,<br>
String id, HelpSet)</code></td>
<td>No Operation</td>
</tr>
</table>
<p align="left"> </p>
<p align="left">One new method is added to <code>ServletHelpBroker</code>:</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr valign="top">
<th height="29">
<div align="left">Method</div>
</th>
<th height="29">
<div align="left">Result</div>
</th>
</tr>
<tr valign="top">
<td><code>NavigatorView getCurrentNavigatorView()</code> </td>
<td>Returns the current navigator as a <code>NavigatorView</code>.</td>
</tr>
</table>
<h4 >Using <tt>ServletHelpBroker</tt></h4>
<p> The <code>ServletHelpBroker</code> is used in the JSP request with
a session scope. With this scope, the help broker remains in existence for the
duration of a session. The following code defines the help broker:</p>
<p ><code><jsp:useBean id="helpBroker" class="ServletHelpBroker"
scope="session" /></code></p>
<p >The <code>ServletHelpBroker</code> methods can be called in two ways:</p>
<ul type="circle">
<li>In tag libraries:
<p><code><jh:validate helpBroker="<%= helpBroker %>" /></code></p>
</li><br><br>
<li>Directly in the JSP:
<p><code><FRAME SRC=<br>
"<jsp:getProperty name="helpBroker" property="currentURL"
/>" <br>
NAME="contentsFrame" SCROLLING="AUTO"></code></p>
</li>
</ul>
<h3><a name="taglib">JavaHelp JSP Tag Extensions</a></h3>
<p>While you could retrieve all the helpset information required for displaying
online help or documentation by using JavaBeans components and JSP scriptlets,
you can instead avoid the appearance of programming and use a standard set of
tag extensions in the JavaHelp tag library to invoke application functionality.
The JavaHelp tag library is a common set of building blocks that perform the
following functions:</p>
<ul type="circle">
<li>Concealing the complexity of access to helpset data</li>
<li>Introducing new scripting variables into a page</li>
<li>Handling iterations without the need for scriptlets</li>
</ul>
<p> The JavaHelp JSP tags are defined below:</p>
<table border="1" cellspacing="0" cellpadding="5" width="95%">
<tr valign="top">
<th width="10%">
<div align="left"><font size="-1">Tag</font></div>
</th>
<th width="10%">
<div align="left"><font size="-1">Tag Class<br>
TEI Class</font></div>
</th>
<th width="35%">
<div align="left"><font size="-1">Description</font></div>
</th>
<th width="45%">
<div align="left"><font size="-1">Attributes</font></div>
</th>
</tr>
<tr valign="top">
<td width="10%"><code><font size="-1">validate</font></code></td>
<td width="10%"><code><font size="-1">ValidateTag</font></code></td>
<td width="35%"><font size="-1">Validates a <code>HelpBroker</code> with various
parameters. Enables easy setup of a help broker with a new helpset. Also
enables merging of helpsets and setting the current ID.</font></td>
<td width="45%">
<dl>
<dt><font size="-1"><code>helpbroker</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1"><code>HelpBroker</code> object </font></dd>
<dt><font size="-1"><code>setInvalidURL</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">String representing the URL for <code>InvalidHelpSet</code>
message.</font></dd>
<dt><font size="-1"><code>helpSetName</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">String representing the URL for <code>the helpset
name.</code></font></dd>
<dt><font size="-1"><code>currentID</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">String id of desired currentID.</font></dd>
<dt><font size="-1"><code>merge</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">Boolean value. If true then merge helpset into current
helpset if one exists. Otherwise do not merge helpset.</font></dd>
</dl>
</td>
</tr>
<tr valign="top">
<td width="10%"><code><font size="-1">navigators</font></code></td>
<td width="10%"><font size="-1">NavigatorsTag<br>
NavigatorsTEI </font></td>
<td width="35%"><font size="-1">Returns <code>NavigatorView</code> information
for a given <code>HelpBroker</code>.</font></td>
<td width="45%">
<dl>
<dt><font size="-1"><code>helpbroker</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1"><code>HelpBroker</code> object </font></dd>
<dt><font size="-1"><code>currentNav</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">String name of the current navigator<code>.</code></font></dd>
</dl>
</td>
</tr>
<tr valign="top">
<td width="10%"><code><font size="-1">tocItem</font></code></td>
<td width="10%"><code><font size="-1">TOCItemTag<br>
TOCItemTEI </font></code></td>
<td width="35%"><font size="-1">Provided with a <code>TOCView</code>, returns
<code>TOCItem</code> information.</font></td>
<td width="45%">
<dl>
<dt><font size="-1"><code>tocView</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1"><code>TOCView</code> object</font></dd>
<dt><font size="-1"><code>helpbroker</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1"><code>HelpBroker</code> object </font></dd>
<dt><font size="-1"><code>baseID</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">Determined by expression. String text for the base
identification of the <code>TOCItem</code>.</font></dd>
</dl>
</td>
</tr>
<tr valign="top">
<td width="10%"><code><font size="-1">indexItem</font></code></td>
<td width="10%"><font size="-1"><code>IndexItemTag<br>
IndexItemTEI</code> </font></td>
<td width="35%"><font size="-1">Provided with an <code>IndexView</code>, returns
<code>IndexItem</code> information.</font></td>
<td width="45%">
<dl>
<dt><font size="-1"><code>IndexView</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1">Determined by expression. <code>IndexView</code> object.</font></dd>
<dt><font size="-1"><code>helpbroker</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1"><code>HelpBroker</code> object </font></dd>
<dt><font size="-1"><code>baseID</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">Determined by expression. String text for the base
identification of the <code>IndexItem</code>.</font></dd>
</dl>
</td>
</tr>
<tr valign="top">
<td width="10%"><code><font size="-1">searchItem</font></code></td>
<td width="10%"><font size="-1"><code>SearchItemTag<br>
SearchItemTEI</code> </font></td>
<td width="35%"><font size="-1">Provided with a <code>SearchView</code>, returns
<code>SearchItem</code> information.</font></td>
<td width="45%">
<dl>
<dt><font size="-1"><code>SearchView</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1">Determined by expression. <code>SearchView</code>
object.</font></dd>
<dt><font size="-1"><code>helpbroker</code> </font>
<dd><font size="-1"><i>required</i></font></dd>
<dd><font size="-1"><code>HelpBroker</code> object </font></dd>
<dt><font size="-1"><code>baseID</code> </font>
<dd><font size="-1"><i>not required</i></font></dd>
<dd><font size="-1">Determined by expression. String text for the base
identification of the <code>SearchItem</code>.</font></dd>
</dl>
</td>
</tr>
</table>
<p>Unless otherwise specified, all attribute values are determined by expression.
Also, with the exception of the <code>validate</code> tag, the body of all tags
are JSP.</p>
<h4>Using the <code>validate</code> Tag</h4>
<p>The <code>validate</code> tag is designed to be used once in a JSP, as shown below:</p>
<p><code><jh:validate helpBroker="<%= helpBroker %>" /></code></p>
<p>The preceding code verifies that a valid <code>HelpBroker</code> exists and then
loads the helpset that has been defined either in the <code>validate</code> tag
with the <code>helpSetName</code> attribute or as an <code>HTTP POST</code> request.</p>
<h3>Navigator Scripting Variables</h3>
<p>The <code>navigator</code>, <code>tocItem</code>, <code>indexItem</code>, and <code>searchItem</code>
tag extensions introduce a predefined set of scripting variables into a page.
These variables enable the calling JSP to control the presentation without having
to perform processing to determine the content. Unless otherwise specified,
each scripting variable creates a new variable, and the scope is set to <code>NESTED</code>.
<code>NESTED</code> variables are available to the calling JSP only within the body
of the defining tag.</p>
<h4>Navigator Variables</h4>
<p>The navigator variables are defined in the table below.</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<th width="63">
<div align="left">Variable</div>
</th>
<th width="37">
<div align="left">Data Type</div>
</th>
<th width="3">
<div align="left">Description</div>
</th>
</tr>
<tr valign="top">
<td ><code>classname</code></td>
<td ><code>java.lang.String</code></td>
<td >Name of the <code>NavigatorView</code> class.</td>
</tr>
<tr valign="top">
<td ><code>name</code></td>
<td ><code>java.lang.String</code></td>
<td >Name of the view as defined in the helpset.</td>
</tr>
<tr valign="top">
<td ><code>tip</code></td>
<td><code>java.lang.String</code></td>
<td>Tooltip text for the view.</td>
</tr>
<tr valign="top">
<td width="63"><code>iconURL</code></td>
<td><code>java.lang.String</code></td>
<td width="3">URL for the icon if set with the <code>imageID</code> attribute
in the helpset.</td>
</tr>
</table>
<h4>Using the Navigator Variables</h4>
<p>The <code>navigator</code> tag is used to return information about the current
navigator. In the illustration below the <code>navigator</code> tag is used to determine
the navigators that are used in the helpset and sets an HTML <code><img></code>
tag based on the navigator name.</p>
<pre><code><jh:navigators helpBroker="<%= helpBroker %>" >
<A HREF="navigator.jsp?nav=<%= name %>">
<IMG src="<%= iconURL!=""?
iconURL : "images/" + className +".gif" %>"
Alt="<%= tip %>"
BORDER=0></A>
</jh:navigators></code></pre>
<h4><tt>tocItem</tt> Variables</h4>
<p>The tocItem variables are defined in the table below.</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr valign="top">
<th>
<div align="left">Variable</div>
</th>
<th>
<div align="left">Data Type</div>
</th>
<th>
<div align="left">Description</div>
</th>
</tr>
<tr valign="top">
<td><code>name</code></td>
<td><code>java.lang.String</code></td>
<td><code>tocItem</code> text as defined in the <code>name</code> attribute.</td>
</tr>
<tr valign="top">
<td><code>target</code></td>
<td><code>java.lang.String</code></td>
<td><code>tocItem</code> target as defined in the <code>target</code> attribute.</td>
</tr>
<tr valign="top">
<td><code>parent</code></td>
<td><code>java.lang.String</code></td>
<td> Hex value identifying the parent node.</td>
</tr>
<tr valign="top">
<td><code>parentID</code></td>
<td><code>java.lang.String</code></td>
<td>String identifying the parent node.</td>
</tr>
<tr valign="top">
<td><code>node</code></td>
<td><code>java.lang.String</code></td>
<td>Hex value identifying this node.</td>
</tr>
<tr valign="top">
<td><code>nodeID</code></td>
<td><code>java.lang.String</code></td>
<td>String identifying this node.</td>
</tr>
<tr valign="top">
<td><code>iconURL</code></td>
<td><code>java.lang.String</code></td>
<td>URL for the icon if set with the <code>imageID</code> attribute in the
<code>tocItem</code>.</td>
</tr>
<tr valign="top">
<td><code>contentURL</code></td>
<td><code>java.lang.String</code></td>
<td>URL for the content represented by this item.</td>
</tr>
<tr valign="top">
<td><code>isCurrentNav</code></td>
<td><code>java.lang.Boolean</code></td>
<td>True if current navigator, false if not.</td>
</tr>
</table>
<h4>Using <tt>tocItem</tt> </h4>
<p>The <code>tocItem</code> tag returns information about the TOC items defined in
a <code>TOCView</code>. In the sample code below, the <code>TOCView</code> returns <code>tocItem</code>
scripting variables that are added to the JavaScript tag <code>tocTree.addTreeNode</code>.</p>
<pre>tocTree = new Tree("tocTree", 22, "ccccff", true, false);
<% TOCView curNav = (TOCView)helpBroker.getCurrentNavigatorView(); %>
<jh:tocItem helpBroker="<%= helpBroker %>" tocView="<%= curNav %>" >
tocTree.addTreeNode("<%= parentID %>",
"<%= nodeID %>",
"<%= iconURL!=""?iconURL:"null" %>",
"<%= name %>","<%= helpID %>",
"<%= contentURL!=""?contentURL:"null" %>",
"<%= expansionType%>" );
</jh:tocItem>
tocTree.drawTree();
tocTree.refreshTree();
<%
ID id = helpBroker.getCurrentID();
if (id != null) {
%>
tocTree.selectFromHelpID("<%= id.id%>");
<%
}
%></pre>
<h4><tt>indexItem</tt> Variables</h4>
<p> The <code>indexItem</code> variables are defined in the table below.</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr valign="top">
<th>
<div align="left">Variable</div>
</th>
<th>
<div align="left">Data Type</div>
</th>
<th>
<div align="left">Description</div>
</th>
</tr>
<tr valign="top">
<td><code>name</code></td>
<td><code>java.lang.String</code></td>
<td><code>indexItem</code> text as defined in the <code>name</code> attribute.</td>
</tr>
<tr valign="top">
<td><code>target</code></td>
<td><code>java.lang.String</code></td>
<td><code>indexItem</code> target as defined in the <code>target</code> attribute.</td>
</tr>
<tr valign="top">
<td><code>parent</code></td>
<td><code>java.lang.String</code></td>
<td> Hex value identifying the parent node.</td>
</tr>
<tr valign="top">
<td><code>parentID</code></td>
<td><code>java.lang.String</code></td>
<td>String identifying the parent node.</td>
</tr>
<tr valign="top">
<td><code>node</code></td>
<td><code>java.lang.String</code></td>
<td>Hex value identifying this node.</td>
</tr>
<tr valign="top">
<td><code>nodeID</code></td>
<td><code>java.lang.String</code></td>
<td>String identifying this node.</td>
</tr>
<tr valign="top">
<td><code>iconURL</code></td>
<td><code>java.lang.String</code></td>
<td>URL for the icon if set with the <code>imageID</code> attribute in the
<code>indexItem</code>.</td>
</tr>
<tr valign="top">
<td><code>contentURL</code></td>
<td><code>java.lang.String</code></td>
<td>URL for the content represented by this item.</td>
</tr>
</table>
<h4>Using <tt>indexItem</tt></h4>
<p>The <code>indexItem</code> tag returns information about the index item defined
in an <code>IndexView</code>. In the sample code below, the <code>IndexView</code>
returns <code>indexItem</code> scripting variables that are added to the JavaScript
tag <code>addNode</code>.</p>
<pre>indexTree = new Tree("indexTree", 22, "ccccff", false, true);
<% IndexView curNav = (IndexView)helpBroker.getCurrentNavigatorView(); %>
<jh:indexItem indexView="<%= curNav %>" helpBroker="<%= helpBroker %>" >
indexTree.addTreeNode("<%= parentID %>",
"<%= nodeID %>", "null",
"<%= name %>","<%= helpID %>",
"<%= contentURL!=""?contentURL:"null" %>",
"<%= expansionType%>");
</jh:indexItem>
indexTree.drawTree();
indexTree.refreshTree();
<%
ID id = helpBroker.getCurrentID();
if (id != null) {
%>
indexTree.selectFromHelpID("<%= id.id%>");
<%
}
%></pre>
<h4> <tt>searchItem</tt> Variables</h4>
<p>The <code>SearchItem</code> variables are defined in the table below.</p>
<table border="1" cellspacing="0" cellpadding="5">
<tr valign="top">
<th>
<div align="left">Variable</div>
</th>
<th>
<div align="left">Data Type</div>
</th>
<th>
<div align="left">Description</div>
</th>
</tr>
<tr valign="top">
<td><code>name</code></td>
<td><code>java.lang.String</code></td>
<td> Unique name of the <code>searchItem</code>.</td>
</tr>
<tr valign="top">
<td><code>helpID</code></td>
<td><code>java.lang.String</code></td>
<td>String ID associated with this <code>searchItem</code>.</td>
</tr>
<tr valign="top">
<td><code>confidence</code></td>
<td><code>java.lang.String</code></td>
<td>The quality of the hits as returned by the search engine.</td>
</tr>
<tr valign="top">
<td><code>hits</code></td>
<td><code>java.lang.String</code></td>
<td>Number of hits.</td>
</tr>
<tr valign="top">
<td> <code>contentURL</code></td>
<td><code>java.lang.String</code></td>
<td>URL for the content represented by this item.</td>
</tr>
<tr valign="top">
<td><code>hitBoundries</code></td>
<td><code>java.lang.String</code></td>
<td>A list of boundaries. Returns in the format of {begin, end},...</td>
</tr>
</table>
<h4> Using <tt>searchItem</tt> </h4>
<p>The <code>searchItem</code> tag returns information about the search items defined
in a <code>SearchView</code>. In the sample code below, the <code>SearchView </code>returns
<code>searchItem</code> scripting variables that are added to the JavaScript tag
<code>addNode</code>.</p>
<pre>searchList = new SearchList("searchList", 22, "ccccff");
<jh:searchTOCItem searchView="<%= curNav %>"
helpBroker="<%= helpBroker %>"
query="<%= query %>" >
searchList.addNode("<%= name %>",
"<%= confidence %>",
"<%= hits %>",
"<%= helpID %>",
"<%= contentURL %>" );
</jh:searchTOCItem>
searchList.drawList();
searchList.refreshList();
searchList.select(0);
</pre>
<p>
<img src="../../images/hg_see.gif"><b>See also:</b>
<dl>
<dd><a href="../author/csh.html">Context-Sensitive Help</a>
<dd>
<dd><a href="dev.html">Programming with the JavaHelp System</a>
<dd><a href="basics.html">Adding the JavaHelp System to Applications</a>
<dd><a href="embed.html">Embedding JavaHelp Components</a>
</dl>
<p>
</body>
</html>