01: package org.gjt.sp.jedit.help;
02:
03: import java.awt.Component;
04: import java.beans.PropertyChangeListener;
05:
06: /**
07: * Interface supported by all HelpViewer classes.
08: * Currently used by @ref infoviewer.InfoViewerPlugin and @ref HelpViewer
09: *
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: * @param url
18: * @param addToHistory
19: * @param scrollPos desired vertical scrollbar position after we go there
20: */
21: public void gotoURL(String url, boolean addToHistory, int scrollPos);
22:
23: public String getBaseURL();
24:
25: public void addPropertyChangeListener(PropertyChangeListener l);
26:
27: /**
28: * Called when the helpviewer is closed
29: */
30: public void dispose();
31:
32: /**
33: * @return the root pane of this help viewer
34: */
35: public Component getComponent();
36:
37: public String getShortURL();
38:
39: public void queueTOCReload();
40:
41: public void setTitle(String newTitle);
42: }
|