/*
* GrabKeyDialog.java - Grabs keys from the keyboard
* :tabSize=4:indentSize=4:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 2001, 2002 Slava Pestov
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package org.gjt.sp.jedit.gui;
//{{{ Imports
import javax.swing.border.*;
import javax.swing.*;
import java.awt.event.*;
import java.awt.*;
import java.lang.reflect.Field;
import java.util.List;
import org.gjt.sp.jedit.*;
import org.gjt.sp.jedit.input.AbstractInputHandler;
import org.gjt.sp.util.Log;
//}}}
/**
* A dialog for getting shortcut keys.
*/
public class GrabKeyDialog extends JDialog
{
//{{{ GrabKeyDialog constructor
/**
* Create and show a new modal dialog.
*
* @param parent center dialog on this component.
* @param binding the action/macro that should get a binding.
* @param allBindings all other key bindings.
* @param debugBuffer debug info will be dumped to this buffer
* (may be null)
* @since jEdit 4.1pre7
*/
public GrabKeyDialog(Dialog parent, KeyBinding binding,
List<KeyBinding> allBindings, Buffer debugBuffer)
{
super(parent,jEdit.getProperty("grab-key.title"),true);
init(binding,allBindings,debugBuffer);
} //}}}
//{{{ GrabKeyDialog constructor
/**
* Create and show a new modal dialog.
*
* @param parent center dialog on this component.
* @param binding the action/macro that should get a binding.
* @param allBindings all other key bindings.
* @param debugBuffer debug info will be dumped to this buffer
* (may be null)
* @since jEdit 4.1pre7
*/
public GrabKeyDialog(Frame parent, KeyBinding binding,
List<KeyBinding> allBindings, Buffer debugBuffer)
{
super(parent,jEdit.getProperty("grab-key.title"),true);
init(binding,allBindings,debugBuffer);
} //}}}
//{{{ getShortcut() method
/**
* Returns the shortcut, or null if the current shortcut should be
* removed or the dialog either has been cancelled. Use isOK()
* to determine if the latter is true.
*/
public String getShortcut()
{
if(isOK)
return shortcut.getShortcut();
else
return null;
} //}}}
//{{{ isOK() method
/**
* Returns true, if the dialog has not been cancelled.
* @since jEdit 3.2pre9
*/
public boolean isOK()
{
return isOK;
} //}}}
//{{{ getFocusTraversalKeysEnabled() method
/**
* Makes the tab key work in Java 1.4.
* @since jEdit 3.2pre4
*/
@Override
public boolean getFocusTraversalKeysEnabled()
{
return false;
} //}}}
//{{{ processKeyEvent() method
@Override
protected void processKeyEvent(KeyEvent evt)
{
shortcut.processKeyEvent(evt);
} //}}}
//{{{ Private members
//{{{ Instance variables
private InputPane shortcut; // this is a bad hack
private JLabel assignedTo;
private JButton ok;
private JButton remove;
private JButton cancel;
private JButton clear;
private boolean isOK;
private KeyBinding binding;
private List<KeyBinding> allBindings;
private Buffer debugBuffer;
//}}}
//{{{ init() method
private void init(KeyBinding binding, List<KeyBinding> allBindings, Buffer debugBuffer)
{
this.binding = binding;
this.allBindings = allBindings;
this.debugBuffer = debugBuffer;
enableEvents(AWTEvent.KEY_EVENT_MASK);
// create a panel with a BoxLayout. Can't use Box here
// because Box doesn't have setBorder().
JPanel content = new JPanel(new GridLayout(0,1,0,6))
{
/**
* Makes the tab key work in Java 1.4.
* @since jEdit 3.2pre4
*/
@Override
public boolean getFocusTraversalKeysEnabled()
{
return false;
}
};
content.setBorder(new EmptyBorder(12,12,12,12));
setContentPane(content);
JLabel label = new JLabel(
debugBuffer == null ? jEdit.getProperty(
"grab-key.caption",new String[] { binding.label })
: jEdit.getProperty("grab-key.keyboard-test"));
Box input = Box.createHorizontalBox();
shortcut = new InputPane();
Dimension size = shortcut.getPreferredSize();
size.width = Integer.MAX_VALUE;
shortcut.setMaximumSize(size);
input.add(shortcut);
input.add(Box.createHorizontalStrut(12));
clear = new JButton(jEdit.getProperty("grab-key.clear"));
clear.addActionListener(new ActionHandler());
input.add(clear);
assignedTo = new JLabel();
if(debugBuffer == null)
updateAssignedTo(null);
Box buttons = Box.createHorizontalBox();
buttons.add(Box.createGlue());
if(debugBuffer == null)
{
ok = new JButton(jEdit.getProperty("common.ok"));
ok.addActionListener(new ActionHandler());
buttons.add(ok);
buttons.add(Box.createHorizontalStrut(12));
if(binding.isAssigned())
{
// show "remove" button
remove = new JButton(jEdit.getProperty("grab-key.remove"));
remove.addActionListener(new ActionHandler());
buttons.add(remove);
buttons.add(Box.createHorizontalStrut(12));
}
}
cancel = new JButton(jEdit.getProperty("common.cancel"));
cancel.addActionListener(new ActionHandler());
buttons.add(cancel);
buttons.add(Box.createGlue());
content.add(label);
content.add(input);
if(debugBuffer == null)
content.add(assignedTo);
content.add(buttons);
setDefaultCloseOperation(DISPOSE_ON_CLOSE);
pack();
setLocationRelativeTo(getParent());
setResizable(false);
setVisible(true);
} //}}}
//{{{ getSymbolicName() method
public static String getSymbolicName(int keyCode)
{
if (Debug.DUMP_KEY_EVENTS)
{
Log.log(Log.DEBUG,GrabKeyDialog.class,"getSymbolicName("+keyCode+").");
}
if(keyCode == KeyEvent.VK_UNDEFINED)
return null;
/* else if(keyCode == KeyEvent.VK_OPEN_BRACKET)
return "[";
else if(keyCode == KeyEvent.VK_CLOSE_BRACKET)
return "]"; */
if(keyCode >= KeyEvent.VK_A && keyCode <= KeyEvent.VK_Z)
return String.valueOf(Character.toLowerCase((char)keyCode));
try
{
Field[] fields = KeyEvent.class.getFields();
for (Field field : fields)
{
String name = field.getName();
if (name.startsWith("VK_") && field.getInt(null) == keyCode)
return name.substring(3);
}
}
catch(Exception e)
{
Log.log(Log.ERROR,GrabKeyDialog.class,e);
}
return null;
} //}}}
//{{{ updateAssignedTo() method
private void updateAssignedTo(String shortcut)
{
String text = jEdit.getProperty("grab-key.assigned-to.none");
KeyBinding kb = getKeyBinding(shortcut);
if(kb != null)
if(kb.isPrefix)
text = jEdit.getProperty(
"grab-key.assigned-to.prefix",
new String[] { shortcut });
else
text = kb.label;
if(ok != null)
ok.setEnabled(kb == null || !kb.isPrefix);
assignedTo.setText(
jEdit.getProperty("grab-key.assigned-to",
new String[] { text }));
} //}}}
//{{{ getKeyBinding() method
private KeyBinding getKeyBinding(String shortcut)
{
if(shortcut == null || shortcut.length() == 0)
return null;
String spacedShortcut = shortcut + ' ';
for (KeyBinding kb : allBindings)
{
if (!kb.isAssigned())
continue;
String spacedKbShortcut = kb.shortcut + ' ';
// eg, trying to bind C+n C+p if C+n already bound
if (spacedShortcut.startsWith(spacedKbShortcut))
return kb;
// eg, trying to bind C+e if C+e is a prefix
if (spacedKbShortcut.startsWith(spacedShortcut))
{
// create a temporary (synthetic) prefix
// KeyBinding, that won't be saved
return new KeyBinding(kb.name, kb.label,
shortcut, true);
}
}
return null;
} //}}}
//}}}
//{{{ KeyBinding class
/**
* A jEdit action or macro with its two possible shortcuts.
* @since jEdit 3.2pre8
*/
public static class KeyBinding
{
public KeyBinding(String name, String label,
String shortcut, boolean isPrefix)
{
this.name = name;
this.label = label;
this.shortcut = shortcut;
this.isPrefix = isPrefix;
}
public String actionSet;
public String name;
public String label;
public String shortcut;
public boolean isPrefix;
public boolean isAssigned()
{
return shortcut != null && shortcut.length() > 0;
}
} //}}}
//{{{ InputPane class
private class InputPane extends JTextField
{
//{{{ getFocusTraversalKeysEnabled() method
/**
* Makes the tab key work in Java 1.4.
* @since jEdit 3.2pre4
*/
@Override
public boolean getFocusTraversalKeysEnabled()
{
return false;
} //}}}
// The public-facing string is converted to a platform-specific
// form, but we keep the canonical shortcut string around for
// internal use.
@Override
public void setText(String s)
{
rawShortcut = (s == null) ? "" : s;
super.setText( GUIUtilities.getPlatformShortcutLabel(s) );
}
public String getShortcut()
{
return rawShortcut;
}
//{{{ processKeyEvent() method
@Override
protected void processKeyEvent(KeyEvent _evt)
{
KeyEvent evt = KeyEventWorkaround.processKeyEvent(_evt);
if(!KeyEventWorkaround.isBindable(_evt.getKeyCode()))
evt = null;
if(debugBuffer != null)
{
debugBuffer.insert(debugBuffer.getLength(),
"Event " + AbstractInputHandler.toString(_evt)
+ (evt == null ? " filtered\n"
: " passed\n"));
}
if(evt == null)
return;
evt.consume();
KeyEventTranslator.Key key = KeyEventTranslator
.translateKeyEvent(evt);
if (Debug.DUMP_KEY_EVENTS)
{
Log.log(Log.DEBUG,GrabKeyDialog.class,"processKeyEvent() key="+key+", _evt="+_evt+'.');
}
if(key == null)
return;
if(debugBuffer != null)
{
debugBuffer.insert(debugBuffer.getLength(),
"==> Translated to " + key + '\n');
}
StringBuilder keyString = new StringBuilder(getShortcut());
if(getDocument().getLength() != 0)
keyString.append(' ');
if(key.modifiers != null)
{
keyString.append(key.modifiers).append('+');
}
String symbolicName = getSymbolicName(key.key);
if(symbolicName != null)
{
keyString.append(symbolicName);
}
else
{
if (key.input != '\0')
{
if (key.input == ' ')
{
keyString.append("SPACE");
}
else
{
keyString.append(key.input);
}
}
else
{
return;
}
}
setText(keyString.toString());
if(debugBuffer == null)
updateAssignedTo(keyString.toString());
} //}}}
protected String rawShortcut = "";
} //}}}
//{{{ ActionHandler class
private class ActionHandler implements ActionListener
{
//{{{ actionPerformed() method
@Override
public void actionPerformed(ActionEvent evt)
{
if(evt.getSource() == ok)
{
if(canClose())
dispose();
}
else if(evt.getSource() == remove)
{
shortcut.setText(null);
isOK = true;
dispose();
}
else if(evt.getSource() == cancel)
dispose();
else if(evt.getSource() == clear)
{
shortcut.setText(null);
if(debugBuffer == null)
updateAssignedTo(null);
shortcut.requestFocus();
}
} //}}}
//{{{ canClose() method
private boolean canClose()
{
String shortcutString = shortcut.getShortcut();
if(shortcutString.length() == 0
&& binding.isAssigned())
{
// ask whether to remove the old shortcut
int answer = GUIUtilities.confirm(
GrabKeyDialog.this,
"grab-key.remove-ask",
null,
JOptionPane.YES_NO_OPTION,
JOptionPane.QUESTION_MESSAGE);
if(answer == JOptionPane.YES_OPTION)
{
shortcut.setText(null);
isOK = true;
}
else
return false;
}
// check whether this shortcut already exists
KeyBinding other = getKeyBinding(shortcutString);
if(other == null || other == binding)
{
isOK = true;
return true;
}
// check whether the other shortcut is the alt. shortcut
if(other.name == binding.name)
{
// we don't need two identical shortcuts
GUIUtilities.error(GrabKeyDialog.this,
"grab-key.duplicate-alt-shortcut",
null);
return false;
}
// check whether shortcut is a prefix to others
if(other.isPrefix)
{
// can't override prefix shortcuts
GUIUtilities.error(GrabKeyDialog.this,
"grab-key.prefix-shortcut",
null);
return false;
}
// ask whether to override that other shortcut
int answer = GUIUtilities.confirm(GrabKeyDialog.this,
"grab-key.duplicate-shortcut",
new Object[] { other.label },
JOptionPane.YES_NO_OPTION,
JOptionPane.QUESTION_MESSAGE);
if(answer == JOptionPane.YES_OPTION)
{
if(other.shortcut != null
&& shortcutString.startsWith(other.shortcut))
{
other.shortcut = null;
}
isOK = true;
return true;
}
else
return false;
} //}}}
} //}}}
}