public class

KeyboardShortcutModuleDescriptor

extends AbstractJiraModuleDescriptor<T>
implements OrderableModuleDescriptor ConditionalDescriptor
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>
       ↳ com.atlassian.jira.plugin.keyboardshortcut.KeyboardShortcutModuleDescriptor

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
KeyboardShortcutModuleDescriptor(JiraAuthenticationContext authenticationContext, KeyboardShortcutManager keyboardShortcutManager, ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescriptorFactory)
Public Methods
void disabled()
void enabled()
Condition getCondition()
int getOrder()
void init(Plugin plugin, Element element)
boolean isHidden()
Protected Methods
KeyboardShortcut createModule()
Creates an instance of the Module.
[Expand]
Inherited Methods
From class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.jira.plugin.OrderableModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware
From interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor

Public Constructors

public KeyboardShortcutModuleDescriptor (JiraAuthenticationContext authenticationContext, KeyboardShortcutManager keyboardShortcutManager, ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescriptorFactory)

Public Methods

public void disabled ()

public void enabled ()

public Condition getCondition ()

public int getOrder ()

public void init (Plugin plugin, Element element)

public boolean isHidden ()

Protected Methods

protected KeyboardShortcut createModule ()

Creates an instance of the Module.

This is called by the lazy load logic of getModule() and is suitable for overriding in subclasses if they want to customize how the Module class is instantiated.

Returns
  • a new instance of the module.