KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > gjt > sp > jedit > help > HelpViewerInterface


1 package org.gjt.sp.jedit.help;
2
3 import java.awt.Component JavaDoc;
4 import java.beans.PropertyChangeListener JavaDoc;
5
6 /**
7  * Interface supported by all HelpViewer classes.
8  * Currently used by @ref infoviewer.InfoViewerPlugin and @ref HelpViewer
9  *
10  * @since Jedit 4.2pre5
11  * @version $Id: HelpViewerInterface.java 5417 2006-05-19 22:33:12Z ezust $
12  */

13 public interface HelpViewerInterface
14 {
15     
16     /**
17      *
18      * @param url
19      * @param addToHistory
20      * @param scrollPos desired vertical scrollbar position after we go there
21      */

22     public void gotoURL(String JavaDoc url, boolean addToHistory, int scrollPos);
23     
24     public String JavaDoc getBaseURL();
25     
26     public void addPropertyChangeListener(PropertyChangeListener JavaDoc l);
27     
28     /**
29      * Called when the helpviewer is closed
30      */

31     public void dispose();
32     /**
33      * @return the root pane of this help viewer
34      */

35     public Component JavaDoc getComponent();
36     public String JavaDoc getShortURL();
37     
38     public void queueTOCReload();
39     public void setTitle(String JavaDoc newTitle);
40 }
41
Popular Tags