Package com.atlassian.confluence.admin.actions.lookandfeel

Class AbstractDecoratorAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.spaces.actions.AbstractSpaceAction

com.atlassian.confluence.admin.actions.lookandfeel.AbstractLookAndFeelAction

com.atlassian.confluence.admin.actions.lookandfeel.AbstractDecoratorAction

All Implemented Interfaces:

WebInterface, SpaceAdministrative, Spaced, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

Direct Known Subclasses:

EditDecoratorAction, ViewDefaultDecoratorAction

public abstract class AbstractDecoratorAction
extends AbstractLookAndFeelAction

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	decoratorName
static String	KLUDGE_CLASSPATH_TEMPLATE
static String	KLUDGE_WWRESOURCE_TEMPLATE	The name of a template that should never be overridden by the user, and thus will be able to give us the default template ResourceLoader.

Fields inherited from class com.atlassian.confluence.admin.actions.lookandfeel.AbstractLookAndFeelAction

colourSchemeManager, layoutHelper

Fields inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

key, notificationManager, space, spaceManager, themeManager, wikiStyleRenderer

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

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
AbstractDecoratorAction()

Method Summary

Modifier and Type	Method	Description
String	getContent()
String	getDecoratorName()
protected String	getTemplateFromResourceLoader(String knownTemplatePath, String templateToRetrieve)	Retrieve a template's source from the same resource loader that was used to load another template.
protected String	getTemplateSource(String template, org.apache.velocity.runtime.resource.loader.ResourceLoader resourceLoader, String encoding)	Get a template's contents, given the name of the template and a ResourceLoader to load it from.
protected String	readDefaultTemplate()
protected void	removeFromVelocityCache(String decorator)	Deprecated. since 5.0 use ConfluenceVelocityResourceCache or rely on CustomLayoutManager to do this automatically for you.
void	setContent(String content)
void	setDecoratorName(String decoratorName)

Methods inherited from class com.atlassian.confluence.admin.actions.lookandfeel.AbstractLookAndFeelAction

getColourSchemeManager, getLayoutHelper, isCustomeThemeSet, isPermitted, isThemeSet, setColourSchemeManager, setLayoutHelper

Methods inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

getKey, getPermissionTypes, getSpace, getSpaceKey, getSubscribableName, getThemeManager, hasSpaceIA, isPersonalSpace, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setThemeManager, setWikiStyleRenderer

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiContentUiSupport, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

Field Detail

KLUDGE_WWRESOURCE_TEMPLATE

public static final String KLUDGE_WWRESOURCE_TEMPLATE

The name of a template that should never be overridden by the user, and thus will be able to give us the default template ResourceLoader. I figure the chance of anyone manually overriding the setup.vmd template is pretty close to nil.

See Also:

Constant Field Values

KLUDGE_CLASSPATH_TEMPLATE

public static final String KLUDGE_CLASSPATH_TEMPLATE

See Also:

Constant Field Values

decoratorName

protected String decoratorName

Constructor Detail

AbstractDecoratorAction

public AbstractDecoratorAction()

Method Detail

readDefaultTemplate

protected String readDefaultTemplate()

Returns:

null if the template couldn't be loaded!

getTemplateFromResourceLoader

protected String getTemplateFromResourceLoader(String knownTemplatePath,
                                               String templateToRetrieve)

Retrieve a template's source from the same resource loader that was used to load another template.

Parameters:

templateToRetrieve - the template we want to get

knownTemplatePath - path to a template for which we know the resource loader

getTemplateSource

protected String getTemplateSource(String template,
                                   org.apache.velocity.runtime.resource.loader.ResourceLoader resourceLoader,
                                   String encoding)

Get a template's contents, given the name of the template and a ResourceLoader to load it from.

Returns:

String the template source

getContent

public String getContent()

getDecoratorName

public String getDecoratorName()

setContent

public void setContent(String content)

setDecoratorName

public void setDecoratorName(String decoratorName)

removeFromVelocityCache

protected void removeFromVelocityCache(String decorator)

Deprecated.

since 5.0 use ConfluenceVelocityResourceCache or rely on CustomLayoutManager to do this automatically for you.