com.atlassian.jira.web.action.util

Class ViewKeyboardShortcuts

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.util.ViewKeyboardShortcuts

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class ViewKeyboardShortcuts
extends JiraWebActionSupport

Displays a help screen showing all the available keyboard shortcuts and descriptions telling users what a particular shortcut will do.

Since:

v4.1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Field Summary

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ViewKeyboardShortcuts(KeyboardShortcutManager keyboardShortcutManager, JiraAuthenticationContext authenticationContext)

Method Summary

Modifier and Type	Method and Description
String	doDefault()
protected String	doExecute()
String	getContextName(KeyboardShortcutManager.Context context)
String[]	getEditorSubmitKeys()
String[]	getFormSubmitKeys()
I18nHelper	getI18nHelper()
Collection<TextOption>	getKeyboardShortcutList() Gets the available list of options for the Keyboard shortcut preference
boolean	getKeyboardShortcutsEnabled()
Map<KeyboardShortcutManager.Context,List<KeyboardShortcut>>	getShortcutsForContext()
boolean	isUserLoggedIn()
void	setKeyboardShortcutsEnabled(boolean keyboardShortcutsEnabled)

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doValidation, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, setErrorMessages

Constructor Detail

ViewKeyboardShortcuts

public ViewKeyboardShortcuts(KeyboardShortcutManager keyboardShortcutManager,
                             JiraAuthenticationContext authenticationContext)

Method Detail

getShortcutsForContext

public Map<KeyboardShortcutManager.Context,List<KeyboardShortcut>> getShortcutsForContext()

getContextName

public String getContextName(KeyboardShortcutManager.Context context)

getI18nHelper

public I18nHelper getI18nHelper()

Overrides:

getI18nHelper in class JiraWebActionSupport

Returns:

the I18nHelper associated with this action

getFormSubmitKeys

public String[] getFormSubmitKeys()

getEditorSubmitKeys

public String[] getEditorSubmitKeys()

getKeyboardShortcutsEnabled

public boolean getKeyboardShortcutsEnabled()

setKeyboardShortcutsEnabled

public void setKeyboardShortcutsEnabled(boolean keyboardShortcutsEnabled)

doExecute

protected String doExecute()
                    throws Exception

Overrides:

doExecute in class webwork.action.ActionSupport

Throws:

Exception

doDefault

public String doDefault()
                 throws Exception

Overrides:

doDefault in class webwork.action.ActionSupport

Throws:

Exception

getKeyboardShortcutList

public Collection<TextOption> getKeyboardShortcutList()

Gets the available list of options for the Keyboard shortcut preference

Returns:

the available list of options for the keyboard shortcut Default preference

isUserLoggedIn

public boolean isUserLoggedIn()