1 /*
2  * @(#)SearchView.java	1.10 06/10/30
3  *
4  * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
5  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6  *
7  * This code is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 only, as
9  * published by the Free Software Foundation.  Sun designates this
10  * particular file as subject to the "Classpath" exception as provided
11  * by Sun in the LICENSE file that accompanied this code.
12  *
13  * This code is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16  * version 2 for more details (a copy is included in the LICENSE file that
17  * accompanied this code).
18  *
19  * You should have received a copy of the GNU General Public License version
20  * 2 along with this work; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
22  *
23  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
24  * CA 95054 USA or visit www.sun.com if you need additional information or
25  * have any questions.
26  */
27 
28 package javax.help;
29 
30 import java.util.Hashtable;
31 import java.awt.Component;
32 import java.util.Locale;
33 
34 /**
35  * Navigational View information for a Search
36  *
37  * @author Eduardo Pelegri-Llopart
38  * @version	1.5	01/29/99
39  */
40 
41 public class SearchView extends NavigatorView {
42     /**
43      * Constructs a SearchView with some given data.  Locale of the View defaults
44      * to that of the HelpSet.
45      *
46      * @param hs The HelpSet that provides context information.
47      * @param name The name of the View.
48      * @param label The label (to show the user) of the View.
49      * @param locale The default locale to interpret the data in this TOC.
50     * @param params A hashtable that provides different key/values for this type.
51     */
SearchView(HelpSet hs, String name, String label, Hashtable params)52     public SearchView(HelpSet hs,
53 		      String name,
54 		      String label,
55 		      Hashtable params) {
56 	super(hs, name, label, hs.getLocale(), params);
57     }
58 
59     /**
60      * Constructs a SearchView with some given data.
61      *
62      * @param hs The HelpSet that provides context information.
63      * @param name The name of the View.
64      * @param label The label (to show the user) of the View.
65      * @param locale The default locale to interpret the data in this TOC.
66     * @param params A hashtable that provides different key/values for this type.
67     */
SearchView(HelpSet hs, String name, String label, Locale locale, Hashtable params)68     public SearchView(HelpSet hs,
69 		      String name,
70 		      String label,
71 		      Locale locale,
72 		      Hashtable params) {
73 	super(hs, name, label, locale, params);
74     }
75 
76     /**
77      * Creates a navigator for a given model.
78      */
createNavigator(HelpModel model)79     public Component createNavigator(HelpModel model) {
80 	return new JHelpSearchNavigator(this, model);
81     }
82 
83 
84 }
85