au.edu.swin.synergy.plugin.help
Class BHelpManager

java.lang.Object
  |
  +--au.edu.swin.synergy.plugin.help.BHelpManager

public class BHelpManager

extends Object

Inner Class Summary

class	BHelpManager.displayWindowListener
class	BHelpManager.onDisplay

Constructor Summary

BHelpManager(BPlugin parent)
Please complete the missing tags for BHelpManager

Method Summary

void	addHelpModule(BHelpTreeModel model) Please complete the missing tags for addHelpModule
void	clearIndexList()
void	doDialect()
URL	getCurrentUrl() Please complete the missing tags for getItems
URL	getHome() Please complete the missing tags for getItems
Vector	getItems() Please complete the missing tags for getItems
DefaultTreeModel	getModel() Please complete the missing tags for getModel
void	jumpToPage(URL url) When user double clicks on node, they can call this to jump straight to the associated page without clicking "Display".
void	registerDisplayButton(JButton button) Please complete the missing tags for getItems
void	setCurrentUrl(URL url) Please complete the missing tags for getItems
void	setTabRef(JComponent tab)
void	setViewpane(BHelpViewpane vp)
void	updateIndex() To include the ability of updating the index when plugins are loaded during run-time, this is called to make sure the index has all the latest items.
void	validateDisplay(JComponent comp)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BHelpManager

public BHelpManager(BPlugin parent)

Please complete the missing tags for BHelpManager

Parameters:

-

Method Detail

doDialect

public void doDialect()

setViewpane

public void setViewpane(BHelpViewpane vp)

setTabRef

public void setTabRef(JComponent tab)

registerDisplayButton

public void registerDisplayButton(JButton button)

Please complete the missing tags for getItems

Parameters:

-

Returns:

Pre Condition:

Post Condition:

validateDisplay

public void validateDisplay(JComponent comp)

getHome

public URL getHome()

Please complete the missing tags for getItems

Parameters:

-

Returns:

Pre Condition:

Post Condition:

jumpToPage

public void jumpToPage(URL url)

When user double clicks on node, they can call this to jump straight to the associated page without clicking "Display".

Parameters:

-

Returns:

Pre Condition:

Post Condition:

updateIndex

public void updateIndex()

To include the ability of updating the index when plugins are loaded during run-time, this is called to make sure the index has all the latest items.

Parameters:

-

Returns:

Pre Condition:

Post Condition:

clearIndexList

public void clearIndexList()

setCurrentUrl

public void setCurrentUrl(URL url)

Please complete the missing tags for getItems

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getCurrentUrl

public URL getCurrentUrl()

Please complete the missing tags for getItems

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getModel

public DefaultTreeModel getModel()

Please complete the missing tags for getModel

Parameters:

-

Returns:

Pre Condition:

Post Condition:

getItems

public Vector getItems()

Please complete the missing tags for getItems

Parameters:

-

Returns:

Pre Condition:

Post Condition:

addHelpModule

public void addHelpModule(BHelpTreeModel model)

Please complete the missing tags for addHelpModule

Parameters:

-

Returns:

Pre Condition:

Post Condition: