001    // GraphLab Project: http://graphlab.sharif.edu
002    // Copyright (C) 2008 Mathematical Science Department of Sharif University of Technology
003    // Distributed under the terms of the GNU General Public License (GPL): http://www.gnu.org/licenses/
004    
005    package graphlab.plugins.commonplugin.help;
006    
007    import graphlab.platform.core.BlackBoard;
008    import graphlab.platform.plugin.PluginMethods;
009    import graphlab.plugins.commonplugin.help.actions.Help;
010    
011    import java.net.URL;
012    
013    /**
014     * @author azin azadi
015     */
016    public class HelpPluginMethods implements PluginMethods {
017        BlackBoard blackboard;
018    
019    //todo: REZA,complete this documentation
020    
021        public HelpPluginMethods(BlackBoard blackboard) {
022            this.blackboard = blackboard;
023        }
024    
025        /**
026         * register som plugin's help contents to be shown on the help of the program
027         *
028         * @param pluginName name of the plugin
029         * @param title      the title to be shown on the screen
030         * @param filter     this filter determines a path to search for files of the help
031         * @return the path to the extracted indexXXXXXX.html of the plugin
032         */
033        public URL registerHelpPlugin(String pluginName, String title, String filter) {
034            return Utils.registerHelpPlugin(blackboard, pluginName, title, filter);
035        }
036    
037        public void showHelpWindow() {
038            Help.showHelpWindow();
039        }
040    }