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

java.lang.Object
  extended by webwork.action.ActionSupport
      extended by com.atlassian.jira.action.JiraActionSupport
          extended by com.atlassian.jira.web.action.JiraWebActionSupport
              extended by 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.ErrorCollection
ErrorCollection.Reason
 
Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper
I18nHelper.BeanFactory
 
Field Summary
 
Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters
 
Fields inherited from class com.atlassian.jira.action.JiraActionSupport
log
 
Fields inherited from class webwork.action.ActionSupport
command, errorMap, errorMessages
 
Fields inherited from interface webwork.action.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
ViewKeyboardShortcuts(KeyboardShortcutManager keyboardShortcutManager, JiraAuthenticationContext authenticationContext)
           
 
Method Summary
 String doDefault()
           
protected  String doExecute()
           
 String getContextName(KeyboardShortcutManager.Context context)
           
 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, addMessageToResponse, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasIssuePermission, hasPermission, hasProjectPermission, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, urlEncode
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getKeysForPrefix, getLocale, getOfBizDelegator, getRemoteUser, getResourceBundle, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError
 
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 com.atlassian.jira.util.ErrorCollection
addError, addErrorMessage, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages
 
Methods inherited from interface webwork.action.CommandDriven
getCommandName, setCommand
 

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 JiraActionSupport
Returns:
the I18nHelper associated with this action

getFormSubmitKeys

public String[] getFormSubmitKeys()

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


Copyright © 2002-2014 Atlassian. All Rights Reserved.