Package com.atlassian.jira.plugin.keyboardshortcut

Class KeyboardShortcutModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<KeyboardShortcut>
com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<KeyboardShortcut>
com.atlassian.jira.plugin.keyboardshortcut.KeyboardShortcutModuleDescriptor
All Implemented Interfaces:
JiraResourcedModuleDescriptor<KeyboardShortcut>, OrderableModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<KeyboardShortcut>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.api.descriptors.ConditionalDescriptor, com.atlassian.plugin.web.descriptors.ConditionalDescriptor
public class KeyboardShortcutModuleDescriptor extends AbstractJiraModuleDescriptor<KeyboardShortcut> implements OrderableModuleDescriptor, com.atlassian.plugin.web.descriptors.ConditionalDescriptor
Provides a plugin point to define keyboard shortcuts. Shortcuts are made up of a set of shortcut keys for this particular operation, the type of operation, a context in which the operation applies and a parameter for the operation. They are also ordered, which defines in which order they will appear on the help screen.
Since:
v4.1

  • Field Summary

    Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

    key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyboardShortcutModuleDescriptor(JiraAuthenticationContext authenticationContext, KeyboardShortcutManager keyboardShortcutManager, com.atlassian.plugin.module.ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescriptorFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected KeyboardShortcut
    createModule()
    Creates an instance of the Module.
    void
    disabled()
     
    void
    enabled()
     
    com.atlassian.plugin.web.Condition
    getCondition()
     
    int
    getOrder()
     
    void
    init(com.atlassian.plugin.Plugin plugin, com.atlassian.plugin.module.Element element)
     
    boolean
    isHidden()
     

    Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor

    assertResourceExists, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, isResourceExist, writeHtml

    Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

    assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    destroy, equals, getCompleteKey, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

    Methods inherited from interface com.atlassian.plugin.Resourced

    getResourceDescriptor, getResourceDescriptors, getResourceLocation

    Methods inherited from interface com.atlassian.plugin.ScopeAware

    getScopeKey