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, 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

Field Summary
 
Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, savedFilters, selectedProject
 
Fields inherited from class com.atlassian.jira.action.JiraActionSupport
log
 
Fields inherited from class webwork.action.ActionSupport
command, errorMap, errorMessages
 
Fields inherited from interface com.atlassian.jira.util.I18nHelper
DEFAULT_RESOURCE_BUNDLE
 
Fields inherited from interface webwork.action.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
WikiRendererHelpAction(com.atlassian.plugin.PluginManager pluginManager)
           
 
Method Summary
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
addErrorCollection, forceRedirect, getAssignableUsers, getAssignableUsers, getCachedGroups, getComponentManager, getConstantsManager, getDateFormat, getDateTimeFormat, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getJiraServiceContext, getLanguage, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRedirect, getRemoteUser, getReturnUrl, getSearchSortReverseDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getText, getTimeFormat, getUserFullName, getVersionManager, getWebworkStack, getWebworkStack, htmlEncode, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isSystemAdministrator, isUserExists, setReturnUrl, setSelectedProjectId
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getApplicationProperties, getDefaultResourceBundle, getDelegator, getJiraLocaleUtils, getLocale, getResult, getText, getText, getText, getText, getText, getText, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isEnterprise, isIndexing, isProfessional, isProfessionalOrEnterprise, isStandard, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doDefault, doValidation, 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
setCommand
 

Constructor Detail

WikiRendererHelpAction

public WikiRendererHelpAction(com.atlassian.plugin.PluginManager pluginManager)
Method Detail

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


Copyright © 2002-2009 Atlassian. All Rights Reserved.