com.atlassian.confluence.admin.actions.macros
Class UserMacroAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.admin.actions.macros.UserMacroAction

All Implemented Interfaces:

WebInterface, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, java.io.Serializable

Direct Known Subclasses:

AddUserMacroAction, RemoveUserMacroAction, UpdateUserMacroAction

public class UserMacroAction
extends ConfluenceActionSupport

Super class for updating the user macro library and the action for viewing the library

See Also:

Serialized Form

Field Summary

protected java.lang.String	macro
protected com.atlassian.renderer.v2.macro.MacroManager	macroManager
protected UserMacroConfig	userMacro
protected UserMacroLibrary	userMacroLibrary

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

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, permissionManager, permitted, pluginAccessor, 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

UserMacroAction()

Method Summary

java.lang.String	doDefault() Default webwork action execution method.
java.util.List<HTMLPairType>	getBodyTypes() Populates the body type select box Only used by AddUserMacroAction and UpdateUserMacroAction If this class gets any more complex consider using delegation
java.util.List<HTMLPairType>	getOutputTypes() Populates the output type select box Only used by AddUserMacroAction and UpdateUserMacroAction If this class gets any more complex consider using delegation
UserMacroConfig	getUserMacro()
UserMacroLibrary	getUserMacros()
boolean	isPermitted()
void	setMacro(java.lang.String macro)
void	setMacroManager(com.atlassian.renderer.v2.macro.MacroManager macroManager)
void	setUserMacro(UserMacroConfig userMacro)
void	setUserMacroLibrary(UserMacroLibrary userMacroLibrary)

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

addActionError, addFieldError, addPermissionTypeTo, addToHistory, 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, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, execute, 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

Field Detail

userMacro

protected UserMacroConfig userMacro

userMacroLibrary

protected UserMacroLibrary userMacroLibrary

macroManager

protected com.atlassian.renderer.v2.macro.MacroManager macroManager

macro

protected java.lang.String macro

Constructor Detail

UserMacroAction

public UserMacroAction()

Method Detail

getUserMacro

public UserMacroConfig getUserMacro()

getUserMacros

public UserMacroLibrary getUserMacros()

setUserMacroLibrary

public void setUserMacroLibrary(UserMacroLibrary userMacroLibrary)

setMacroManager

public void setMacroManager(com.atlassian.renderer.v2.macro.MacroManager macroManager)

setMacro

public void setMacro(java.lang.String macro)

setUserMacro

public void setUserMacro(UserMacroConfig userMacro)

doDefault

public java.lang.String doDefault()
                           throws java.lang.Exception

Description copied from class: ConfluenceActionSupport

Default webwork action execution method.

Overrides:

doDefault in class ConfluenceActionSupport

Returns:

the action result

Throws:

java.lang.Exception - if something goes wrong

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

getOutputTypes

public java.util.List<HTMLPairType> getOutputTypes()

Populates the output type select box Only used by AddUserMacroAction and UpdateUserMacroAction If this class gets any more complex consider using delegation

Returns:

list of output types

getBodyTypes

public java.util.List<HTMLPairType> getBodyTypes()

Populates the body type select box Only used by AddUserMacroAction and UpdateUserMacroAction If this class gets any more complex consider using delegation

Returns:

list of body types