HelpViewerInterface (GroIMP 2.1.4 API)

All Known Implementing Classes:: HelpViewer

public interface HelpViewerInterface

Interface supported by all HelpViewer classes. Currently used by @ref infoviewer.InfoViewerPlugin and @ref HelpViewer

Since:: Jedit 4.2pre5
Version:: $Id: HelpViewerInterface.java 25243 2020-04-15 14:51:21Z kpouer $

Method Summary

Modifier and Type

Method

Description

void

addPropertyChangeListener(PropertyChangeListener l)

void

dispose()

Called when the helpviewer is closed

String

getBaseURL()

Component

getComponent()

String

getShortURL()

void

gotoURL(String url, boolean addToHistory, int scrollPos)

void

queueTOCReload()

void

setTitle(String newTitle)

Method Details
- gotoURL
  
  void gotoURL(String url, boolean addToHistory, int scrollPos)
  
  Parameters:
  
  url -
  
  addToHistory -
  
  scrollPos - desired vertical scrollbar position after we go there
- getBaseURL
  
  String getBaseURL()
- addPropertyChangeListener
  
  void addPropertyChangeListener(PropertyChangeListener l)
- dispose
  
  void dispose()
  
  Called when the helpviewer is closed
- getComponent
  
  Component getComponent()
  
  Returns:
  
  the root pane of this help viewer
- getShortURL
  
  String getShortURL()
- queueTOCReload
  
  void queueTOCReload()
- setTitle
  
  void setTitle(String newTitle)