PageRenderTime 40ms CodeModel.GetById 14ms RepoModel.GetById 0ms app.codeStats 0ms

/jEdit/tags/jedit-4-3-pre5/org/gjt/sp/jedit/help/HelpViewerInterface.java

#
Java | 40 lines | 14 code | 7 blank | 19 comment | 0 complexity | 8fd08021102a7766dc9ce25ca1c0ae6f MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. package org.gjt.sp.jedit.help;
    2. 

  2. 

  3. import java.awt.Component;
    4. 

  4. import java.beans.PropertyChangeListener;
    5. 

  5. 

  6. /**
    7. 

  7.  * Interface supported by all HelpViewer classes.
    8. 

  8.  * Currently used by @ref infoviewer.InfoViewerPlugin and @ref HelpViewer 
    9. 

  9.  * 
    10. 

  10.  * @since Jedit 4.2pre5
    11. 

  11.  * @version $Id: HelpViewerInterface.java 5417 2006-05-19 22:33:12Z ezust $
    12. 

  12.  */
    13. 

  13. public interface HelpViewerInterface 
    14. 

  14. {
    15. 

  15. 	
    16. 

  16. 	/**
    17. 

  17. 	 * 
    18. 

  18. 	 * @param url
    19. 

  19. 	 * @param addToHistory 
    20. 

  20. 	 * @param scrollPos desired vertical scrollbar position after we go there
    21. 

  21. 	 */
    22. 

  22. 	public void gotoURL(String url, boolean addToHistory, int scrollPos);
    23. 

  23. 	
    24. 

  24. 	public String getBaseURL();
    25. 

  25. 	
    26. 

  26. 	public void addPropertyChangeListener(PropertyChangeListener l);
    27. 

  27. 	
    28. 

  28. 	/**
    29. 

  29. 	 * Called when the helpviewer is closed
    30. 

  30. 	 */
    31. 

  31. 	public void dispose();
    32. 

  32. 	/**
    33. 

  33. 	 * @return the root pane of this help viewer
    34. 

  34. 	 */
    35. 

  35. 	public Component getComponent();
    36. 

  36. 	public String getShortURL();
    37. 

  37. 	
    38. 

  38. 	public void queueTOCReload();
    39. 

  39. 	public void setTitle(String newTitle);
    40. 

  40. }
    41. 

  41.