GraphLab Project

graphlab.plugins.commonplugin.help
Class Utils

java.lang.Object
  extended by graphlab.plugins.commonplugin.help.Utils

public class Utils
extends java.lang.Object


Field Summary
static java.lang.String helpPreDestDir
           
static java.util.Hashtable<java.lang.String,java.net.URL> pluginHelps
           
 
Constructor Summary
Utils()
           
 
Method Summary
static java.net.URL registerHelpPlugin(BlackBoard blackboard, java.lang.String pluginName, java.lang.String title, java.lang.String filter)
          Register a help entry on help menu.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

helpPreDestDir

public static java.lang.String helpPreDestDir

pluginHelps

public static java.util.Hashtable<java.lang.String,java.net.URL> pluginHelps
Constructor Detail

Utils

public Utils()
Method Detail

registerHelpPlugin

public static java.net.URL registerHelpPlugin(BlackBoard blackboard,
                                              java.lang.String pluginName,
                                              java.lang.String title,
                                              java.lang.String filter)
Register a help entry on help menu.

Parameters:
blackboard - blackboard!
pluginName - name of plugin (= jar file) containing help files.
title - Title that will be shown to user for help entry
filter - Prefix path of help content in jar file
Returns:
URL of index of registered help. This url will be opened when user selects the registered title of help.

GraphLab Project