Package com.atlassian.jira.web.action.renderers.wiki

Class WikiRendererHelpAction

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

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

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, 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 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, 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	Description
WikiRendererHelpAction(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method	Description
protected String	doExecute()
Collection	getContentLinkHelpForSection(String section)	Gets any help text that have been registered from content link plugins for the specified section.
Collection	getContentLinkHelpNoSection()	Gets any help text that have been registered from content link plugins without specifying a section.
Collection	getMacroHelpForSection(String section)	Gets any help text that have been registered from macro plugins for the specified section.
Collection	getMacroHelpNoSection()	Gets any help text that have been registered from macro plugins without specifying a section.
Collection	getRendererComponentFactoriesHelpForSection(String section)	Gets any help text that have been registered from renderer component plugins for the specified section.
Collection	getRendererComponentFactoriesHelpNoSection()	Gets any help text that have been registered from renderer component plugins without specifying a section.
String	getSection()
void	setSection(String section)

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, getActionNameJspa, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, 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, doDefault, 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 Details

WikiRendererHelpAction

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

Method Details

doExecute

protected String doExecute()
                    throws Exception

Overrides:

doExecute in class webwork.action.ActionSupport

Throws:

Exception

getSection

public String getSection()

setSection

public void setSection(String section)

getMacroHelpForSection

public Collection getMacroHelpForSection(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 Collection getMacroHelpNoSection()

Gets any help text that have been registered from macro plugins without specifying a section.

Returns:

matching help modules

getContentLinkHelpForSection

public Collection getContentLinkHelpForSection(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 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 Collection getRendererComponentFactoriesHelpForSection(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 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