|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.plugin.keyboardshortcut.CachingKeyboardShortcutManager
public class CachingKeyboardShortcutManager
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.atlassian.jira.plugin.keyboardshortcut.KeyboardShortcutManager |
---|
KeyboardShortcutManager.Context, KeyboardShortcutManager.Operation |
Constructor Summary | |
---|---|
CachingKeyboardShortcutManager(BuildUtilsInfo buildUtilsInfo,
com.atlassian.plugin.PluginAccessor pluginAccessor,
com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration,
JiraAuthenticationContext authenticationContext,
UserPreferencesManager userPreferencesManager)
|
Method Summary | |
---|---|
List<KeyboardShortcut> |
getActiveShortcuts()
Returns an ordered list of active KeyboardShortcut s, sorted using the plugin descriptor's
order attribute. |
List<KeyboardShortcut> |
getAllShortcuts()
Returns an ordered list of all KeyboardShortcut s available
using the plugin descriptor's 'order' attribute for sorting. |
String |
includeShortcuts()
Returns a URL to be used to include the currently registered keyboard shortcuts in a page. |
boolean |
isKeyboardShortcutsEnabled()
Returns if the user has keyboard shortcuts enabled. |
List<KeyboardShortcut> |
listActiveShortcutsUniquePerContext(Map<String,Object> userContext)
Returns an ordered list of active KeyboardShortcut s, sorted using the plugin descriptor's
order attribute. |
void |
onClearCache(ClearCacheEvent event)
|
void |
registerShortcut(String pluginModuleKey,
KeyboardShortcut shortcut)
Given a complete plugin module key, this method registers a keyboard shortcut with the manager, which will make it available in the UI to end-users. |
void |
requireShortcutsForContext(KeyboardShortcutManager.Context context)
Register that the keyboard shortcuts for the context should be included by KeyboardShortcutManager.includeShortcuts() (in
addition to the global shortcuts, which are always included). |
void |
unregisterShortcut(String pluginModuleKey)
Removes a keyboard shortcut by its complete plugin module key. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CachingKeyboardShortcutManager(BuildUtilsInfo buildUtilsInfo, com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration, JiraAuthenticationContext authenticationContext, UserPreferencesManager userPreferencesManager)
Method Detail |
---|
@EventListener public void onClearCache(ClearCacheEvent event)
public void registerShortcut(String pluginModuleKey, KeyboardShortcut shortcut)
KeyboardShortcutManager
registerShortcut
in interface KeyboardShortcutManager
pluginModuleKey
- the complete plugin module key for this keyboard shortcutshortcut
- the shortcut to registerpublic void unregisterShortcut(String pluginModuleKey)
KeyboardShortcutManager
unregisterShortcut
in interface KeyboardShortcutManager
pluginModuleKey
- the key to removepublic List<KeyboardShortcut> getActiveShortcuts()
KeyboardShortcutManager
KeyboardShortcut
s, sorted using the plugin descriptor's
order
attribute.
A shortcut is active if it has not been overriden by another shortcut that uses the same key combination and has
a greater value in its order
attribute (see the keyboard shortcut plugin module documentation).
getActiveShortcuts
in interface KeyboardShortcutManager
public List<KeyboardShortcut> listActiveShortcutsUniquePerContext(Map<String,Object> userContext)
KeyboardShortcutManager
KeyboardShortcut
s, sorted using the plugin descriptor's
order
attribute.
A shortcut is considered active if
KeyboardShortcutManager.Context
that
uses the same key combination and has a greater value in its order
attribute (see the
keyboard
shortcut plugin module documentation). Thus this list can contain multiple shortcuts with the same
key combination, which all belong to a different context.
listActiveShortcutsUniquePerContext
in interface KeyboardShortcutManager
userContext
- the context to be used when evaluating, whether the user is allowed to use the shortcut; not
null
KeyboardShortcutManager.Context
; not null
public List<KeyboardShortcut> getAllShortcuts()
KeyboardShortcutManager
KeyboardShortcut
s available
using the plugin descriptor's 'order' attribute for sorting. Implementations should take care to implement this
method as quickly as possible since it will be called very often.
Note this method returns all registered shortcuts, even if they are not in effect (e.g. they have been
overridden). This means that this method may return duplicate shortcuts.
getAllShortcuts
in interface KeyboardShortcutManager
KeyboardShortcutManager.getActiveShortcuts()
public void requireShortcutsForContext(KeyboardShortcutManager.Context context)
KeyboardShortcutManager
KeyboardShortcutManager.includeShortcuts()
(in
addition to the global
shortcuts, which are always included).
requireShortcutsForContext
in interface KeyboardShortcutManager
context
- the context whose keyboard shorcuts should be included (in addition to global
).public String includeShortcuts()
KeyboardShortcutManager
/rest/api/1.0/shortcuts/500/f1e3b05a6e6db41e5b77fb8afd7ddde9/shortcuts.js
It has been suggested that webresources (with say the systemcounter) would be a good fit for this, however the
problem is that the systemcounter would have to be updated everytime a plugin is enabled/disabled (so everytime
JIRA is started up), which would have some adverse side effects:
includeShortcuts
in interface KeyboardShortcutManager
KeyboardShortcutManager.requireShortcutsForContext(com.atlassian.jira.plugin.keyboardshortcut.KeyboardShortcutManager.Context)
public boolean isKeyboardShortcutsEnabled()
KeyboardShortcutManager
isKeyboardShortcutsEnabled
in interface KeyboardShortcutManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |