blob: ca462438463dd8be2bb9709dd32813488aaf136f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<title>Javadoc Index Search Window</title>
<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
</head>
<body>
<p><a id="javadoc.search.window" name="javadoc.search.window"></a></p>
<div id="NBCSH836"><!-- infolevel="all" infotype="General" --><a id="sthref79" name="sthref79"></a>
<h1>Javadoc Index Search Window</h1>
<a name="BEGIN" id="BEGIN"></a>
<p>The Javadoc Index Search window enables you to search for and view Javadoc in the IDE.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2108">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<p>The Javadoc Index Search window contains the following elements:</p>
<table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t80">Element</th>
<th align="left" valign="bottom" id="r1c2-t80">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t80" headers="r1c1-t80">
<p>Toolbar</p>
</td>
<td align="left" headers="r2c1-t80 r1c2-t80">Type a string in the text field and click Find to search the Javadoc index.
<p>The search is case sensitive.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t80" headers="r1c1-t80">
<p>Search Results</p>
</td>
<td align="left" headers="r3c1-t80 r1c2-t80">Displays a list of Javadoc that match the search string.
<p>Use the buttons in the toolbar to sort the results by name, package or type. Select an entry to view the Javadoc in the HTML Viewer. Double-click an entry to open the Javadoc in your browser.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t80" headers="r1c1-t80">
<p>HTML Viewer</p>
</td>
<td align="left" headers="r4c1-t80 r1c2-t80">Displays the Javadoc page for the selected search result.
<p>Click the Toggle button in the toolbar to display or hide the HTML Viewer.</p>
</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<p>The following icons are used in the toolbar of the Javadoc Index Search window:</p>
<table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t81">Element</th>
<th align="left" valign="bottom" id="r1c2-t81">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t81" headers="r1c1-t81">
<p><img width="16" height="16" src="img/javadoc-showsource.gif" alt="Show Source icon" title="Show Source icon" /></p></td>
<td align="left" headers="r2c1-t81 r1c2-t81">Show the Javadoc source on your local file system</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t81" headers="r1c1-t81">
<p><img width="16" height="16" src="img/javadoc-alphasort.gif" alt="Sort by Name icon" title="Sort by Name icon" /></p></td>
<td align="left" headers="r3c1-t81 r1c2-t81">Sort Javadoc by name</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t81" headers="r1c1-t81">
<p><img width="16" height="16" src="img/javadoc-refsort.gif" alt="Sort by Packages icon" title="Sort by Packages icon" /></p></td>
<td align="left" headers="r4c1-t81 r1c2-t81">Sort Javadoc by packages</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t81" headers="r1c1-t81">
<p><img width="16" height="16" src="img/javadoc-typesort.gif" alt="Sort by Type icon" title="Sort by Type icon" /></p></td>
<td align="left" headers="r5c1-t81 r1c2-t81">Sort Javadoc by type</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t81" headers="r1c1-t81">
<p><img width="32" height="16" src="img/javadoc-listhtml.gif" alt="Toggle the Display View icon" title="Toggle the Display View icon" /></p></td>
<td align="left" headers="r6c1-t81 r1c2-t81">Toggle the HTML display of the Javadoc</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<a id="NBCSH845" name="NBCSH845"></a>
<hr><p><b>Related Topics</b></p>
<p><i>Developing Applications with NetBeans IDE</i>,
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2103">
<param name="text" value="<html><u>&quot;Working with Javadoc Documentation&quot;</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<!-- -->
<!-- Start Footer -->
<table summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" width="86%"><a href="legal_notice.htm">
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.</a>
</td>
</tr>
</table>
<!-- -->
</body>
</html>