Desktop: Add a button in dockbar to get the help about the component
[scilab.git] / scilab / modules / gui / src / java / org / scilab / modules / gui / utils / SciHelpOnComponentAction.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2010 - Calixte DENIZET
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  */
12
13 package org.scilab.modules.gui.utils;
14
15 import java.awt.event.ActionEvent;
16
17 import javax.swing.AbstractAction;
18
19 import org.scilab.modules.gui.bridge.CallScilabBridge;
20 import org.scilab.modules.gui.bridge.tab.SwingScilabTab;
21
22 /**
23  * Action executed when the user clicks on the "Help button"
24  * @author Calixte DENIZET
25  */
26 public class SciHelpOnComponentAction extends AbstractAction {
27
28     private static final long serialVersionUID = 1L;
29
30     private SwingScilabTab associatedTab;
31
32     /**
33      * Constructor
34      * @param tab the associated tab
35      */
36     public SciHelpOnComponentAction(SwingScilabTab tab) {
37         associatedTab = tab;
38     }
39
40     /**
41      * What do I have to do when the event accurs
42      * @param arg0 the event
43      * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
44      */
45     public void actionPerformed(ActionEvent arg0) {
46         String id = associatedTab.getAssociatedXMLIDForHelp();
47         CallScilabBridge.openHelp(id);
48     }
49 }