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.ScopeAware, com.atlassian.plugin.StateAware, 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 and Description
KeyboardShortcutModuleDescriptor(JiraAuthenticationContext authenticationContext, KeyboardShortcutManager keyboardShortcutManager, com.atlassian.plugin.module.ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescriptorFactory)

Method Summary

Modifier and Type	Method and 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, 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, 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, provideValidationRules, satisfiesMinJavaVersion, setBroken, 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, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Constructor Detail

KeyboardShortcutModuleDescriptor

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

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()

getCondition

public com.atlassian.plugin.web.Condition getCondition()

Specified by:

getCondition in interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor