com.atlassian.jira.web.action.renderers.wiki
Class WikiRendererHelpAction

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.renderers.wiki.WikiRendererHelpAction
All Implemented Interfaces:
ErrorCollection, I18nHelper, java.io.Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class WikiRendererHelpAction
extends JiraWebActionSupport

A webwork action that controls the display of the wiki renderers help.

See Also:
Serialized Form

Nested Class Summary
 
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
WikiRendererHelpAction(com.atlassian.plugin.PluginAccessor pluginAccessor)
           
 
Method Summary
protected  java.lang.String doExecute()
           
 java.util.Collection getContentLinkHelpForSection(java.lang.String section)
          Gets any help text that have been registered from content link plugins for the specified section.
 java.util.Collection getContentLinkHelpNoSection()
          Gets any help text that have been registered from content link plugins without specifying a section.
 java.util.Collection getMacroHelpForSection(java.lang.String section)
          Gets any help text that have been registered from macro plugins for the specified section.
 java.util.Collection getMacroHelpNoSection()
          Gets any help text that have been registered from macro plugins without specifying a section.
 java.util.Collection getRendererComponentFactoriesHelpForSection(java.lang.String section)
          Gets any help text that have been registered from renderer component plugins for the specified section.
 java.util.Collection getRendererComponentFactoriesHelpNoSection()
          Gets any help text that have been registered from renderer component plugins without specifying a section.
 java.lang.String getSection()
           
 void setSection(java.lang.String section)
           
 
Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
addErrorCollection, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, forceRedirect, getApplicationProperties, getAssignableUsers, getAssignableUsers, getCachedGroups, getComponentManager, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraServiceContext, getLanguage, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRandomHint, getRedirect, getRemoteUser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getText, getTimeFormat, getUriValidator, getUserFullName, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, htmlEncode, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, setConglomerateCookieValue, setInline, setReturnUrl, setSelectedProjectId
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getDefaultResourceBundle, getDelegator, getKeysForPrefix, getLocale, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText0, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isEnterprise, isIndexing, isProfessional, isProfessionalOrEnterprise, isStandard, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doDefault, doValidation, getCommandName, getErrorMessages, getErrors, 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, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages
 
Methods inherited from interface webwork.action.CommandDriven
getCommandName, setCommand
 

Constructor Detail

WikiRendererHelpAction

public WikiRendererHelpAction(com.atlassian.plugin.PluginAccessor pluginAccessor)
Method Detail

doExecute

protected java.lang.String doExecute()
                              throws java.lang.Exception
Overrides:
doExecute in class webwork.action.ActionSupport
Throws:
java.lang.Exception

getSection

public java.lang.String getSection()

setSection

public void setSection(java.lang.String section)

getMacroHelpForSection

public java.util.Collection getMacroHelpForSection(java.lang.String section)
Gets any help text that have been registered from macro plugins for the specified section.

Parameters:
section - the help section you want to render
Returns:
matching help modules

getMacroHelpNoSection

public java.util.Collection getMacroHelpNoSection()
Gets any help text that have been registered from macro plugins without specifying a section.

Returns:
matching help modules

getContentLinkHelpForSection

public java.util.Collection getContentLinkHelpForSection(java.lang.String section)
Gets any help text that have been registered from content link plugins for the specified section.

Parameters:
section - the help section you want to render
Returns:
matching help modules
Since:
v3.12

getContentLinkHelpNoSection

public java.util.Collection getContentLinkHelpNoSection()
Gets any help text that have been registered from content link plugins without specifying a section.

Returns:
matching help modules
Since:
v3.12

getRendererComponentFactoriesHelpForSection

public java.util.Collection getRendererComponentFactoriesHelpForSection(java.lang.String section)
Gets any help text that have been registered from renderer component plugins for the specified section.

Parameters:
section - the help section you want to render
Returns:
matching help modules
Since:
v3.12

getRendererComponentFactoriesHelpNoSection

public java.util.Collection getRendererComponentFactoriesHelpNoSection()
Gets any help text that have been registered from renderer component plugins without specifying a section.

Returns:
matching help modules
Since:
v3.12


Copyright © 2002-2010 Atlassian. All Rights Reserved.