Class javax.help.DefaultHelpHistoryModel

java.lang.Object
    |
    +----javax.help.DefaultHelpHistoryModel

public class DefaultHelpHistoryModel
extends java.lang.Object
implements HelpHistoryModel
DefaultHelpHistoryModel is default implementation of HelpHistoryModel interface


history

protected java.util.Vector history

historyIndex

protected int historyIndex

helpModel

protected HelpModel helpModel

listenerList

protected EventListenerList listenerList

help

protected JHelp help

DefaultHelpHistoryModel

public DefaultHelpHistoryModel(JHelp help)
Creates new DefaultHelpHistoryModel for given JHelp
Parameters:
help - The JHelp

setHelpModel

public void setHelpModel(HelpModel model)
Sets a new HelpModel
Implements:
setHelpModel in interface HelpHistoryModel
Parameters:
model - The new HelpModel

removeHelpHistoryModelListener

public void removeHelpHistoryModelListener(HelpHistoryModelListener l)
Removes a listener previously added with addHelpHistoryModelListener
Implements:
removeHelpHistoryModelListener in interface HelpHistoryModel
Parameters:
l - The listener to remove.
See Also:
addHelpHistoryModelListener

addHelpHistoryModelListener

public void addHelpHistoryModelListener(HelpHistoryModelListener l)
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.
Implements:
addHelpHistoryModelListener in interface HelpHistoryModel
Parameters:
l - The listener to add.
See Also:
removeHelpHistoryModelListener

discard

public void discard()
Discards a history
Implements:
discard in interface HelpHistoryModel

getHistory

public java.util.Vector getHistory()
Returns a history
Implements:
getHistory in interface HelpHistoryModel
Returns:
The vector of history entries

removeLastEntry

public void removeLastEntry()
Removes the last history entry

getIndex

public int getIndex()
Returns a current history position
Implements:
getIndex in interface HelpHistoryModel
Returns:
The history index

goForward

public void goForward()
Sets the next history entry
Implements:
goForward in interface HelpHistoryModel

goBack

public void goBack()
Sets the previous histroy entry
Implements:
goBack in interface HelpHistoryModel

getForwardHistory

public java.util.Vector getForwardHistory()
Returns a forward history vector
Implements:
getForwardHistory in interface HelpHistoryModel
Returns:
The vector of forward history entries

getBackwardHistory

public java.util.Vector getBackwardHistory()
Returns a backward history vector
Implements:
getBackwardHistory in interface HelpHistoryModel
Returns:
The vector of backward history entries

setHistoryEntry

public void setHistoryEntry(int index)
Sets the current history entry
Implements:
setHistoryEntry in interface HelpHistoryModel
Parameters:
index - The index of history entry

fireHistoryChanged

protected void fireHistoryChanged(java.lang.Object source,
                                  boolean previous,
                                  boolean next)
Fires the history change

idChanged

public void idChanged(HelpModelEvent e)
Tells the listener that the current ID in the HelpModel has changed. All highlights from the previous location change at this point.
Parameters:
e - The event

removeHelpSet

public void removeHelpSet(HelpSet hs)
Removes entries related to removed HelpSet from history
Implements:
removeHelpSet in interface HelpHistoryModel
Parameters:
hs - The removed HelpSet

getModel

protected HelpModel getModel()
Returns HelpModel
Returns:
The HelpModel