Refactorization of the management of the actions in menus, button, shortcuts
[scilab.git] / scilab / modules / scinotes / src / java / org / scilab / modules / scinotes / actions / HelpOnKeywordAction.java
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2009 - DIGITEO - Bruno JOFRET
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.scinotes.actions;
14
15 import java.beans.PropertyChangeEvent;
16 import java.beans.PropertyChangeListener;
17
18 import javax.swing.JMenuItem;
19 import javax.swing.KeyStroke;
20 import javax.swing.text.BadLocationException;
21
22 import org.scilab.modules.gui.menuitem.MenuItem;
23 import org.scilab.modules.scinotes.SciNotes;
24 import org.scilab.modules.scinotes.ScilabLexerConstants;
25 import org.scilab.modules.scinotes.ScilabEditorPane;
26 import org.scilab.modules.scinotes.KeywordEvent;
27 import org.scilab.modules.action_binding.InterpreterManagement;
28
29 /**
30  * HelpOnKeywordAction Class
31  * @author Calixte DENIZET
32  */
33 public class HelpOnKeywordAction extends DefaultAction {
34
35     /**
36      * Constructor
37      * @param name the name of the action
38      * @param editor SciNotes
39      */
40     public HelpOnKeywordAction(String name, SciNotes editor) {
41         super(name, editor);
42     }
43
44     /**
45      * doAction
46      */
47     public void doAction() {
48         KeywordEvent kwe = ((ScilabEditorPane) getEditor().getTextPane()).getKeywordEvent();
49         if (ScilabLexerConstants.isHelpable(kwe.getType())) {
50             try {
51                 String kw = getEditor().getTextPane().getDocument().getText(kwe.getStart(), kwe.getLength());
52             InterpreterManagement.requestScilabExec("help('" + kw + "')");
53             } catch (BadLocationException e) { }
54         }
55     }
56
57     /**
58      * createMenu
59      * @param label label of the menu
60      * @param editor SciNotes
61      * @param key Keystroke
62      * @return MenuItem
63      */
64     public static MenuItem createMenu(String label, final SciNotes editor, KeyStroke key) {
65         final MenuItem menuitem = createMenu(label, null, new HelpOnKeywordAction(label, editor), key);
66         ((JMenuItem) menuitem.getAsSimpleMenuItem()).addPropertyChangeListener(new PropertyChangeListener() {
67                 public void propertyChange(PropertyChangeEvent e) {
68                     KeywordEvent kwe = ((ScilabEditorPane) editor.getTextPane()).getKeywordEvent();
69                     menuitem.setEnabled(ScilabLexerConstants.isHelpable(kwe.getType()));
70                 }
71             });
72
73         return menuitem;
74     }
75 }