com.atlassian.jira.plugin.keyboardshortcut
Interface KeyboardShortcutManager

All Known Implementing Classes:
CachingKeyboardShortcutManager

@PublicApi
public interface KeyboardShortcutManager

Provides a registry of keyboard shortcuts currently available in JIRA. Keyboard shortcuts can be provided via the KeyboardShortcut plugin point. In order for keyboard shortcuts to remain consistent across a cluster, they should be added or removed simultaneously across the cluster, e.g. upon startup, not at arbitrary times such as in response to user input.

Since:
v4.1

Nested Class Summary
static class KeyboardShortcutManager.Context
          Defines the context under which a keyboard shortcut is valid.
static class KeyboardShortcutManager.Operation
          Defines the different operations that can be taken using a KeyboardShortcut.
 
Method Summary
 List<KeyboardShortcut> getActiveShortcuts()
          Deprecated. uses listActiveShortcutsUniquePerContext(java.util.Map) under the hood
 List<KeyboardShortcut> getAllShortcuts()
          Returns an ordered list of all KeyboardShortcuts 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 KeyboardShortcuts, sorted using the plugin descriptor's order attribute.
 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 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.
 

Method Detail

registerShortcut

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.

Parameters:
pluginModuleKey - the complete plugin module key for this keyboard shortcut
shortcut - the shortcut to register

unregisterShortcut

void unregisterShortcut(String pluginModuleKey)
Removes a keyboard shortcut by its complete plugin module key.

Parameters:
pluginModuleKey - the key to remove

getActiveShortcuts

@Deprecated
List<KeyboardShortcut> getActiveShortcuts()
Deprecated. uses listActiveShortcutsUniquePerContext(java.util.Map) under the hood

Returns an ordered list of active KeyboardShortcuts, 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).

Returns:
ordered list of all active keyboard shortcuts
Since:
5.0.2

listActiveShortcutsUniquePerContext

List<KeyboardShortcut> listActiveShortcutsUniquePerContext(Map<String,Object> userContext)
Returns an ordered list of active KeyboardShortcuts, sorted using the plugin descriptor's order attribute.

A shortcut is considered active if

  1. All conditions attached to the keyboard shortcut are fulfilled, so that the current user is allowed to use it.
  2. It has not been overriden by another shortcut of the same 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.

Be aware, that this operation is potentially expensive, depending on the number and type of conditions attached to the keyboard shortcuts. So store the result in favour of recalculating it.

Parameters:
userContext - the context to be used when evaluating, whether the user is allowed to use the shortcut; not null
Returns:
ordered list of all active keyboard shortcuts, no duplicate shortcuts per KeyboardShortcutManager.Context; not null
Since:
5.0.4

getAllShortcuts

List<KeyboardShortcut> getAllShortcuts()
Returns an ordered list of all KeyboardShortcuts 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.

Returns:
ordered list of all registered keyboard shortcuts
See Also:
getActiveShortcuts()

requireShortcutsForContext

void requireShortcutsForContext(KeyboardShortcutManager.Context context)
Register that the keyboard shortcuts for the context should be included by includeShortcuts() (in addition to the global shortcuts, which are always included).

Parameters:
context - the context whose keyboard shorcuts should be included (in addition to global).

includeShortcuts

String includeShortcuts()
Returns a URL to be used to include the currently registered keyboard shortcuts in a page. The URL should point to the Keyboard Shortcut REST resource. Generally this URL will look something like: /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:

That's why this uses a md5 checksum of the shortcuts in the URL instead of the web-resources approach.

It does not contain the applications context path. Also, the hash included at the end of the URL should be a hash of all keyboard shortcuts currently available such that the resource can be cached indefinitely. If a new shortcut is registered (or an old shortcut unregistered), then the hash should obviously change.

Returns:
URL pointing to a REST resource to included keyboard shortcuts. The URL will be correctly URL-escaped, but it is not HTML escaped.
See Also:
requireShortcutsForContext(com.atlassian.jira.plugin.keyboardshortcut.KeyboardShortcutManager.Context)

isKeyboardShortcutsEnabled

boolean isKeyboardShortcutsEnabled()
Returns if the user has keyboard shortcuts enabled. If the user is not logged in this will default to true

Returns:
boolean indicating if the user has keyboard shortcuts enabled. Defaults to true if the user is not logged in.


Copyright © 2002-2015 Atlassian. All Rights Reserved.