public final class Shortcut extends Object
registerShortcut(java.lang.String, java.lang.String, int, int)
factory. Ignore everything
else.
All: Use only public methods that are also marked to be used. The others are
public so the shortcut preferences can use them.Modifier and Type | Field and Description |
---|---|
static int |
ALT |
static int |
ALT_CTRL |
static int |
ALT_CTRL_SHIFT |
static int |
ALT_SHIFT |
private boolean |
assignedDefault |
private int |
assignedKey |
private int |
assignedModifier |
private boolean |
assignedUser |
private boolean |
automatic |
static int |
CTRL |
static int |
CTRL_SHIFT |
static int |
DIRECT |
private static Map<Integer,Integer> |
groups |
private static boolean |
initdone |
private static int[] |
keys |
private String |
longText |
static int |
MNEMONIC |
private static int[] |
mods |
static int |
NONE |
private int |
requestedGroup |
private int |
requestedKey |
static int |
RESERVED |
private boolean |
reset |
static int |
SHIFT |
private static Map<String,Shortcut> |
shortcuts |
private String |
shortText |
Modifier | Constructor and Description |
---|---|
private |
Shortcut(String prefString) |
private |
Shortcut(String shortText,
String longText,
int requestedKey,
int requestedGroup,
int assignedKey,
int assignedModifier,
boolean assignedDefault,
boolean assignedUser) |
Modifier and Type | Method and Description |
---|---|
private static void |
doInit() |
private static int |
findModifier(int group,
Integer modifier) |
static Shortcut |
findShortcut(int requestedKey,
int modifier) |
boolean |
getAssignedDefault() |
int |
getAssignedKey() |
int |
getAssignedModifier() |
boolean |
getAssignedUser() |
boolean |
getAutomatic() |
static KeyStroke |
getCopyKeyStroke()
Replies the platform specific key stroke for the 'Copy' command, i.e.
|
static KeyStroke |
getCutKeyStroke()
Replies the platform specific key stroke for the 'Cut' command, i.e.
|
private static int |
getGroupModifier(int group) |
KeyStroke |
getKeyStroke()
Use this to register the shortcut with Swing
|
String |
getKeyText()
use this to get a human readable text for your shortcut
|
String |
getLongText() |
static KeyStroke |
getPasteKeyStroke()
Replies the platform specific key stroke for the 'Paste' command, i.e.
|
private boolean |
getReset() |
String |
getShortText() |
boolean |
isChangeable() |
boolean |
isEvent(KeyEvent e) |
private boolean |
isSame(int isKey,
int isModifier) |
static List<Shortcut> |
listAll()
FOR PREF PANE ONLY
|
static Shortcut |
registerShortcut(String shortText,
String longText,
int requestedKey,
int requestedGroup)
Register a shortcut.
|
private static Shortcut |
registerShortcut(String shortText,
String longText,
int requestedKey,
int requestedGroup,
Integer modifier) |
static Shortcut |
registerSystemShortcut(String shortText,
String longText,
int key,
int modifier)
FOR PLATFORMHOOK USE ONLY
This registers a system shortcut.
|
private boolean |
save() |
private void |
saveDefault() |
static boolean |
savePrefs() |
void |
setAccelerator(AbstractAction action)
use this to set a actions's accelerator
|
void |
setAssignedKey(int assignedKey)
FOR PREF PANE ONLY
|
void |
setAssignedModifier(int assignedModifier)
FOR PREF PANE ONLY
|
void |
setAssignedUser(boolean assignedUser)
FOR PREF PANE ONLY
|
void |
setAutomatic()
FOR PREF PANE ONLY
|
private void |
setLongText(String longText) |
void |
setMnemonic(AbstractButton button)
use this to set a buttons's mnemonic
|
void |
setMnemonic(JMenu menu)
use this to set a menu's mnemonic
|
String |
toString() |
private final int requestedKey
private final int requestedGroup
private int assignedKey
private int assignedModifier
private boolean assignedDefault
private boolean assignedUser
private boolean automatic
private boolean reset
public static final int NONE
public static final int MNEMONIC
public static final int RESERVED
public static final int DIRECT
public static final int ALT
public static final int SHIFT
public static final int CTRL
public static final int ALT_SHIFT
public static final int ALT_CTRL
public static final int CTRL_SHIFT
public static final int ALT_CTRL_SHIFT
private static int[] mods
private static int[] keys
private static boolean initdone
private Shortcut(String shortText, String longText, int requestedKey, int requestedGroup, int assignedKey, int assignedModifier, boolean assignedDefault, boolean assignedUser)
public String getShortText()
public String getLongText()
private void setLongText(String longText)
public int getAssignedKey()
public int getAssignedModifier()
public boolean getAssignedDefault()
public boolean getAssignedUser()
public boolean getAutomatic()
public boolean isChangeable()
private boolean getReset()
public void setAutomatic()
public void setAssignedModifier(int assignedModifier)
public void setAssignedKey(int assignedKey)
public void setAssignedUser(boolean assignedUser)
public KeyStroke getKeyStroke()
private void saveDefault()
private boolean save()
private boolean isSame(int isKey, int isModifier)
public void setMnemonic(JMenu menu)
public void setMnemonic(AbstractButton button)
public void setAccelerator(AbstractAction action)
public String getKeyText()
public static Shortcut findShortcut(int requestedKey, int modifier)
private static void doInit()
private static int getGroupModifier(int group)
private static int findModifier(int group, Integer modifier)
public static boolean savePrefs()
public static Shortcut registerSystemShortcut(String shortText, String longText, int key, int modifier)
public static Shortcut registerShortcut(String shortText, String longText, int requestedKey, int requestedGroup)
shortText
- an ID. re-use a "system:*"
ID if possible, else use something unique.
"menu:*"
is reserved for menu mnemonics, "core:*"
is reserved for
actions that are part of JOSM's core. Use something like
<pluginname>+":"+<actionname>
.longText
- this will be displayed in the shortcut preferences dialog. Better
use something the user will recognize...requestedKey
- the key you'd prefer. Use a KeyEvent.VK_*
constant here.requestedGroup
- the group this shortcut fits best. This will determine the
modifiers your shortcut will get assigned. Use the constants defined above.private static Shortcut registerShortcut(String shortText, String longText, int requestedKey, int requestedGroup, Integer modifier)
public static KeyStroke getCopyKeyStroke()
public static KeyStroke getPasteKeyStroke()
public static KeyStroke getCutKeyStroke()