com.atlassian.jira.plugin.keyboardshortcut
Class KeyboardShortcutModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      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.StateAware

public class KeyboardShortcutModuleDescriptor
extends AbstractJiraModuleDescriptor<KeyboardShortcut>
implements OrderableModuleDescriptor

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.jira.plugin.AbstractJiraModuleDescriptor

RESOURCE_TYPE_I18N

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

moduleClass, moduleClassName, plugin, resources, singleton

Constructor Summary

KeyboardShortcutModuleDescriptor(JiraAuthenticationContext authenticationContext, KeyboardShortcutManager keyboardShortcutManager, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

protected KeyboardShortcut	createModule() Creates an instance of the Module.
void	disabled()
void	enabled()
int	getOrder()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.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

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

assertModuleClassImplements, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

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, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Constructor Detail

KeyboardShortcutModuleDescriptor

public KeyboardShortcutModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                        KeyboardShortcutManager keyboardShortcutManager,
                                        com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<KeyboardShortcut>

Overrides:

init in class AbstractJiraModuleDescriptor<KeyboardShortcut>

Throws:

com.atlassian.plugin.PluginParseException

createModule

protected KeyboardShortcut createModule()

Description copied from class: AbstractJiraModuleDescriptor

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.

Overrides:

createModule in class AbstractJiraModuleDescriptor<KeyboardShortcut>

Returns:

a new instance of the module.

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class AbstractJiraModuleDescriptor<KeyboardShortcut>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class AbstractJiraModuleDescriptor<KeyboardShortcut>

getOrder

public int getOrder()

Specified by:

getOrder in interface OrderableModuleDescriptor

isHidden

public boolean isHidden()