New Java Help Browser for Scilab.
[scilab.git] / scilab / modules / gui / src / java / org / scilab / modules / gui / helpbrowser / HelpBrowser.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2008 - INRIA - Vincent Couvert
4  * 
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at    
9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  */
12
13 package org.scilab.modules.gui.helpbrowser;
14
15 import org.scilab.modules.gui.dockable.Dockable;
16
17 /**
18  * Interface for Scilab Help Browser in GUIs
19  * @author Vincent COUVERT
20  */
21 public interface HelpBrowser extends Dockable {
22
23         /**
24          * Gets this Bridge component object
25          * @return this Bridge component object
26          */
27         SimpleHelpBrowser getAsSimpleHelpBrowser();
28
29         /**
30          * Display the Help Browser
31          */
32         void display();
33         
34         /**
35          * Display the matching items for a specified keyword
36          * @param keyword the keyword
37          * @return true if the keyword exists
38          */
39         boolean searchKeywork(String keyword);
40         
41         /**
42          * Close the HelpBrowser
43          */
44         void close();
45 }