javax.help.event

Class HelpModelEvent


public class HelpModelEvent
extends java.util.EventObject

Notifies interested parties that a change in a Help Model source has occurred.

Constructor Summary

HelpModelEvent(Object source, int pos0, int pos1)
Creates a HelpModelEvent for highlighting.
HelpModelEvent(Object source, Map.ID id, URL url)
Represents a change in the JavaHelp in the current ID or URL.
HelpModelEvent(Object source, Map.ID id, URL url, String historyName, JHelpNavigator navigator)
Represents a change in the JavaHelp in the current ID or URL.

Method Summary

String
getHistoryName()
Returns the name of this entry
Map.ID
getID()
Returns the current ID in the HelpModel.
JHelpNavigator
getNavigator()
Returns the navigator of this entry
int
getPos0()
int
getPos1()
URL
getURL()
Returns the current URL in the HelpModel.

Constructor Details

HelpModelEvent

public HelpModelEvent(Object source,
                      int pos0,
                      int pos1)
Creates a HelpModelEvent for highlighting.
Parameters:
source - The source for this event.
pos0 - Start position.
pos1 - End position.

HelpModelEvent

public HelpModelEvent(Object source,
                      Map.ID id,
                      URL url)
Represents a change in the JavaHelp in the current ID or URL.
Parameters:
source - The source for this event.
id - The ID that has changed. Should be null if URL is specified.
url - The URL that has changed. Should be null if ID is specified.
See Also:
javax.help.JavaHelp

HelpModelEvent

public HelpModelEvent(Object source,
                      Map.ID id,
                      URL url,
                      String historyName,
                      JHelpNavigator navigator)
Represents a change in the JavaHelp in the current ID or URL.
Parameters:
source - The source for this event.
id - The ID that has changed. Should be null if URL is specified.
url - The URL that has changed. Should be null if ID is specified.
historyName - The name of selected entry
navigator - The JHelpNavigator
See Also:
javax.help.JavaHelp

Method Details

getHistoryName

public String getHistoryName()
Returns the name of this entry
Returns:
The entry name

getID

public Map.ID getID()
Returns the current ID in the HelpModel.
Returns:
The current ID.

getNavigator

public JHelpNavigator getNavigator()
Returns the navigator of this entry
Returns:
The navigator name

getPos0

public int getPos0()
Returns:
The start position of this (highlighting) event.

getPos1

public int getPos1()
Returns:
The end position of this (highlighting) event.

getURL

public URL getURL()
Returns the current URL in the HelpModel.
Returns:
The current URL.