HelpViewerInterface.java

package org.gjt.sp.jedit.help;

import java.awt.Component;
import java.beans.PropertyChangeListener;

/**
 * Interface supported by all HelpViewer classes.
 * Currently used by @ref infoviewer.InfoViewerPlugin and @ref HelpViewer 
 * 
 * @since Jedit 4.2pre5
 * @version $Id: HelpViewerInterface.java 12504 2008-04-22 23:12:43Z ezust $
 */
public interface HelpViewerInterface 
{
	
	/**
	 * 
	 * @param url
	 * @param addToHistory 
	 * @param scrollPos desired vertical scrollbar position after we go there
	 */
	public void gotoURL(String url, boolean addToHistory, int scrollPos);
	
	public String getBaseURL();
	
	public void addPropertyChangeListener(PropertyChangeListener l);
	
	/**
	 * Called when the helpviewer is closed
	 */
	public void dispose();
	/**
	 * @return the root pane of this help viewer
	 */
	public Component getComponent();
	public String getShortURL();
	
	public void queueTOCReload();
	public void setTitle(String newTitle);
}