Changeset 25110 in osm for applications/editors/josm/plugins

Timestamp:

2011-01-22T16:39:26+01:00 (14 years ago)

Author:

guggis

Message:

Fixed help context

Location:

applications/editors/josm/plugins/scripting

Files:

• scripts/AddHouseNumbers.groovy (modified) (9 diffs)
• src/org/openstreetmap/josm/plugins/scripting/HelpAwareOptionPane.java (deleted)
• src/org/openstreetmap/josm/plugins/scripting/RunScriptAction.java (modified) (2 diffs)
• src/org/openstreetmap/josm/plugins/scripting/RunScriptDialog.java (modified) (18 diffs)
• src/org/openstreetmap/josm/plugins/scripting/ScriptEngineSelectionDialog.java (modified) (4 diffs)
• src/org/openstreetmap/josm/plugins/scripting/preferences/ConfigureAction.java (modified) (3 diffs)
• src/org/openstreetmap/josm/plugins/scripting/preferences/PreferenceEditor.java (modified) (2 diffs)

applications/editors/josm/plugins/scripting/scripts/AddHouseNumbers.groovy

@@ +1 @@
+/*
+ * This scripts sets a sequence of consecutive house numbers on the currently selected nodes.
+ *  
+ */
+import java.awt.event.WindowAdapter;
 
-/*
- * This scripts sets a sequence of house numbers on the currently selected nodes.
- * 
- * The user can enter a start number and and an increment.
- */
 
 import java.awt.BorderLayout;
@@ -10 +10 @@
 
 import java.awt.event.KeyEvent;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowListener;
 
 import javax.swing.KeyStroke;
 
 import groovy.swing.SwingBuilder;
+import groovy.util.ProxyGenerator;
+
 import javax.swing.JOptionPane;
 import org.openstreetmap.josm.Main;
@@ -35 +39 @@
 import java.awt.GridBagLayout;
 import javax.swing.JLabel;
+import java.awt.event.FocusListener;
 
 import javax.swing.Action;
@@ -43 +48 @@
 import java.awt.event.ActionListener;
 import java.awt.Dimension;
+import java.awt.Dialog.ModalityType;
+import java.awt.event.WindowEvent;
 
 class AddHouseNumberDialog extends JDialog {
@@ -56 +63 @@
         private JTextField tfStart;
         private JTextField tfIncrement;
+        private def actApply;
         
         public AddHouseNumberDialog(){
-                super(Main.parent, true /* modal */)
+                super(Main.parent,true)
                 build();
         }
@@ -95 +103 @@
                 SwingBuilder swing = new SwingBuilder()
                 return swing.panel(layout: new FlowLayout(FlowLayout.CENTER)) {
-                    def actApply = action(name: "Apply", smallIcon: ImageProvider.get("ok"), closure: {apply(); setVisible(false)})
+                    actApply = action(name: "Apply", smallIcon: ImageProvider.get("ok"), closure: {apply(); setVisible(false)})
                         def btnApply = button(action: actApply)
                         btnApply.setFocusable(true)
@@ -114 +122 @@
                         return
                 }
-                def cmds = getCurrentlySelectedNodes().collect { Node n ->
+                def nodes = Main?.map?.mapView?.editLayer?.data?.getSelectedNodes()?.asList()
+                if (nodes == null || nodes.isEmpty()) return
+                def cmds = nodes.collect { Node n ->
                         Node nn = new Node(n)
                         nn.put("addr:housenumber", start.toString())
@@ -120 +130 @@
                         return new ChangeCommand(n, nn)                 
                 }
-                if (cmds.isEmpty()) return
                 Main.main.undoRedo.add(new SequenceCommand("Setting house numbers", cmds))
         }
@@ -131 +140 @@
                 cp.add(buildInputPanel(), BorderLayout.CENTER)
                 cp.add(buildControlButtonPanel(), BorderLayout.SOUTH)
-        }       
-        
-        def getCurrentDataSet() {
-                def layer = Main?.map?.mapView?.activeLayer
-                if (layer == null) return null
-                if (! (layer instanceof OsmDataLayer)) return null
-                return layer.data
-        }
-        
-        def getCurrentlySelectedNodes() {
-                def DataSet ds = getCurrentDataSet()
-                if (ds == null) return []
-                return ds.getSelectedNodes().asList()
-        }
+                
+                addWindowListener([windowActivated: {tfStart.requestFocusInWindow()}] as WindowAdapter) 
+                getRootPane().registerKeyboardAction(actApply, KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,KeyEvent.CTRL_MASK, false), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT)
+        }               
 
         @Override

applications/editors/josm/plugins/scripting/src/org/openstreetmap/josm/plugins/scripting/RunScriptAction.java

@@ -4 +4 @@
 import java.awt.event.KeyEvent;
 
+import javax.swing.KeyStroke;
+
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.JosmAction;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.Shortcut;
@@ -20 +23 @@
                 );              
                 putValue(MNEMONIC_KEY, KeyEvent.VK_R);
+                putValue("help", HelpUtil.ht("/Plugin/Scripting"));
         }
 

applications/editors/josm/plugins/scripting/src/org/openstreetmap/josm/plugins/scripting/RunScriptDialog.java

@@ -11 +11 @@
 import java.awt.Insets;
 import java.awt.event.ActionEvent;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
 import java.io.File;
 import java.io.FileReader;
@@ -24 +26 @@
 import javax.script.ScriptException;
 import javax.swing.AbstractAction;
+import javax.swing.Action;
 import javax.swing.JButton;
+import javax.swing.JComponent;
 import javax.swing.JDialog;
 import javax.swing.JFileChooser;
@@ -31 +35 @@
 import javax.swing.JPanel;
 import javax.swing.JTextField;
+import javax.swing.KeyStroke;
 import javax.swing.SwingUtilities;
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.gui.HelpAwareOptionPane;
 import org.openstreetmap.josm.gui.SideButton;
 import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
@@ -41 +47 @@
 import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
 import org.openstreetmap.josm.plugins.scripting.preferences.PreferenceKeys;
+import org.openstreetmap.josm.plugins.scripting.util.IOUtil;
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.WindowGeometry;
@@ -53 +60 @@
         /** the input field for the script file name */
         private HistoryComboBox cbScriptFile;
+        private Action actRun;
         
         /**
@@ -60 +68 @@
          */
         public RunScriptDialog(Component parent) {
-                super(JOptionPane.getFrameForComponent(parent), true);
+                super(JOptionPane.getFrameForComponent(parent), ModalityType.DOCUMENT_MODAL);
                 build();
+                HelpUtil.setHelpContext(this.getRootPane(), HelpUtil.ht("/Plugin/Scripting"));
         }
         
@@ -78 +87 @@
         protected JPanel buildControlButtonPanel() {
                 JPanel pnl = new JPanel(new FlowLayout(FlowLayout.CENTER));
-                pnl.add(new SideButton(new RunAction()));
+                JButton btn;
+                
+                pnl.add(btn = new SideButton(actRun = new RunAction()));
+                btn.setFocusable(true);
+                btn.registerKeyboardAction(actRun, KeyStroke.getKeyStroke("ENTER"), JComponent.WHEN_FOCUSED);
                 pnl.add(new SideButton(new CancelAction()));
-                pnl.add(new SideButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Plugin/Macro#Run"))));
+                pnl.add(new SideButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Plugin/Scripting#Run"))));
                 return pnl;
         }
@@ -108 +121 @@
                 gc.fill = GridBagConstraints.BOTH;
                 gc.insets = new Insets(3,0 /* no spacing to the left */,3,3);
-                pnl.add(new JButton(new SelectMacroFileAction()), gc);
+                JButton btn;
+                pnl.add(btn = new JButton(new SelectMacroFileAction()), gc);
+                btn.setFocusable(false);
                                 
                 // just a filler 
@@ -135 +150 @@
                 getContentPane().add(buildContentPanel(), BorderLayout.CENTER);
                 
+                getRootPane().registerKeyboardAction(actRun, KeyStroke.getKeyStroke("ctrl ENTER"), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
                 setTitle(tr("Run a script"));
                 setSize(600, 150);
+                
+                addWindowListener(new WindowAdapter() {
+                        @Override
+                        public void windowActivated(WindowEvent e) {
+                                cbScriptFile.requestFocusInWindow();
+                        }                       
+                });
         }
         
@@ -194 +217 @@
                                         tr("File not found"),
                                         JOptionPane.ERROR_MESSAGE,
-                                        null // no help topic
+                                        HelpUtil.ht("/Plugin/Scripting")
                         );                      
                 }
@@ -204 +227 @@
                                         tr("Empty file name"),
                                         JOptionPane.ERROR_MESSAGE,
-                                        null // no help topic
+                                        HelpUtil.ht("/Plugin/Scripting")
                         );                      
                 }
@@ -214 +237 @@
                                         tr("File not readable"),
                                         JOptionPane.ERROR_MESSAGE,
-                                        null // no help topic
+                                        HelpUtil.ht("/Plugin/Scripting")
                         );                      
                 }
@@ -224 +247 @@
                                         tr("IO error"),
                                         JOptionPane.ERROR_MESSAGE,
-                                        null // no help topic
+                                        HelpUtil.ht("/Plugin/Scripting")
                         );                      
                         System.out.println(tr("Failed to read a macro from the file ''{0}''.", f.toString()));
@@ -236 +259 @@
                                         tr("Script Error"),
                                         JOptionPane.ERROR_MESSAGE,
-                                        null // no help topic
+                                        HelpUtil.ht("/Plugin/Scripting")
                         );                      
                         System.out.println(tr("Macro execution has failed."));
@@ -252 +275 @@
                                         + "</html>"
                                         ,
-                                        tr("No scripting engine"),
-                                        JOptionPane.ERROR_MESSAGE,
-                                        null // no help topic
+                                        tr("No script engine"),
+                                        JOptionPane.ERROR_MESSAGE,
+                                        HelpUtil.ht("/Plugin/Scripting")
                         );
                 }
@@ -292 +315 @@
                         final ScriptEngine engine = getScriptEngine(f);
                         if (engine == null) return;
-                
+                        setVisible(false);              
+
                         SwingUtilities.invokeLater(
                             new Runnable() {
@@ -300 +324 @@
                                                         if (engine instanceof Compilable) {
                                                                 CompiledScript script = CompiledScriptCache.getInstance().compile((Compilable)engine,f);
-                                                                logger.info("running compiled script for " + f);
                                                                 script.eval();
                                                         } else {
@@ -311 +334 @@
                                                         warnFailedToOpenMacroFile(f, e);
                                                 } finally {
-                                                        if (reader != null){
-                                                                try {reader.close();} catch(IOException e) {}
-                                                        }
+                                                        IOUtil.close(reader);
                                                 }
                                 }
                             }
-                    );
-                        
-                        setVisible(false);              
+                    );          
                 }       
         }

applications/editors/josm/plugins/scripting/src/org/openstreetmap/josm/plugins/scripting/ScriptEngineSelectionDialog.java

@@ -82 +82 @@
          */
         public ScriptEngineSelectionDialog(Component parent) {
-                super(JOptionPane.getFrameForComponent(parent), true /* modal */);
+                super(JOptionPane.getFrameForComponent(parent), ModalityType.APPLICATION_MODAL);
                 build();
+                HelpUtil.setHelpContext(getRootPane(), HelpUtil.ht("/Plugin/Scripting"));
         }
         
@@ -107 +108 @@
                 pnl.add(btn = new SideButton(actCancel = new CancelAction()));
                 btn.setFocusable(true);
-                pnl.add(btn = new SideButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Plugins/Scripting#SelectScriptingEngine"))));
+                pnl.add(btn = new SideButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Plugin/Scripting"))));
                 btn.setFocusable(true);
                 
@@ -113 +114 @@
                 getRootPane().registerKeyboardAction(
                                 actOK,  
-                                KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, InputEvent.CTRL_DOWN_MASK), 
+                                KeyStroke.getKeyStroke("ctrl ENTER"), 
                                 JComponent.WHEN_IN_FOCUSED_WINDOW
                 );
@@ -120 +121 @@
                 getRootPane().registerKeyboardAction(
                                 actCancel,  
-                                KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), 
+                                KeyStroke.getKeyStroke("ESC"), 
                                 JComponent.WHEN_IN_FOCUSED_WINDOW
                 );

applications/editors/josm/plugins/scripting/src/org/openstreetmap/josm/plugins/scripting/preferences/ConfigureAction.java

@@ -12 +12 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.JosmAction;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.PreferenceDialog;
 import org.openstreetmap.josm.plugins.scripting.RunScriptDialog;
@@ -24 +25 @@
                         false                // don't register
                 );              
+                putValue("help", HelpUtil.ht("/Plugin/Scripting"));
         }
         
@@ -62 +64 @@
                          */
                         for(int i=0; i< tp.getTabCount(); i++) {
-                                if (getChildByName(tp.getComponentAt(i), "scripting.preferences.editor") != null) {
+                                if (getChildByName(tp.getComponentAt(i), PreferenceEditor.NAME) != null) {
                                         tp.setSelectedIndex(i);
                                         break;

applications/editors/josm/plugins/scripting/src/org/openstreetmap/josm/plugins/scripting/preferences/PreferenceEditor.java

@@ -13 +13 @@
 
 public class PreferenceEditor extends JPanel implements PreferenceSetting {
+        static public final String NAME = "scripting.preferences.editor";
         
         private JTabbedPane tpPreferenceTabs;
@@ -34 +35 @@
         JPanel tab = gui.createPreferenceTab("script-engine", tr("Scripting"), description);        
         tab.add(this, GBC.eol().fill(GBC.BOTH));
-        this.setName("scripting.preferences.editor");
+        this.setName(NAME);
         }