com.atlassian.confluence.renderer.actions
Class NotationHelpAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.renderer.actions.NotationHelpAction

All Implemented Interfaces:

WebInterface, Action, LocaleProvider, TextProvider, Validateable, ValidationAware, Serializable

public class NotationHelpAction
extends ConfluenceActionSupport

Displays help for Wiki notation, remembering the last help section the user viewed.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, permissionManager, permitted, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

NotationHelpAction()

Method Summary

String	execute()
List<com.atlassian.plugin.ModuleDescriptor>	getMacroHelpForSection(String sectionKey)
String	getSection()
String[]	getSectionKeys()
boolean	hasHelpForSection(String sectionKey) Returns true if help exists for this section, either dynamic via descriptors or static in templates.
boolean	isCamelCaseEnabled()
void	setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
void	setSection(String section)

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermitted, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

NotationHelpAction

public NotationHelpAction()

Method Detail

execute

public String execute()
               throws Exception

Specified by:

execute in interface Action

Overrides:

execute in class ActionSupport

Throws:

Exception

getSectionKeys

public String[] getSectionKeys()

getSection

public String getSection()

setSection

public void setSection(String section)

getMacroHelpForSection

public List<com.atlassian.plugin.ModuleDescriptor> getMacroHelpForSection(String sectionKey)

hasHelpForSection

public boolean hasHelpForSection(String sectionKey)

Returns true if help exists for this section, either dynamic via descriptors or static in templates.

isCamelCaseEnabled

public boolean isCamelCaseEnabled()

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

Overrides:

setPluginAccessor in class ConfluenceActionSupport