GraphLab Project

graphlab.plugins.commonplugin.help
Class HelpPluginMethods

java.lang.Object
  extended by graphlab.plugins.commonplugin.help.HelpPluginMethods
All Implemented Interfaces:
PluginMethods

public class HelpPluginMethods
extends java.lang.Object
implements PluginMethods

Author:
azin azadi

Constructor Summary
HelpPluginMethods(BlackBoard blackboard)
           
 
Method Summary
 java.net.URL registerHelpPlugin(java.lang.String pluginName, java.lang.String title, java.lang.String filter)
          register som plugin's help contents to be shown on the help of the program
 void showHelpWindow()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HelpPluginMethods

public HelpPluginMethods(BlackBoard blackboard)
Method Detail

registerHelpPlugin

public java.net.URL registerHelpPlugin(java.lang.String pluginName,
                                       java.lang.String title,
                                       java.lang.String filter)
register som plugin's help contents to be shown on the help of the program

Parameters:
pluginName - name of the plugin
title - the title to be shown on the screen
filter - this filter determines a path to search for files of the help
Returns:
the path to the extracted indexXXXXXX.html of the plugin

showHelpWindow

public void showHelpWindow()

GraphLab Project