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

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.spaces.actions.AbstractSpaceAction
              extended by com.atlassian.confluence.admin.actions.lookandfeel.AbstractLookAndFeelAction
                  extended by com.atlassian.confluence.admin.actions.lookandfeel.AbstractDecoratorAction
All Implemented Interfaces:
WebInterface, SpaceAdministrative, Spaced, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable
Direct Known Subclasses:
EditDecoratorAction, ViewDefaultDecoratorAction

public abstract class AbstractDecoratorAction
extends AbstractLookAndFeelAction

See Also:
Serialized Form

Field Summary
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
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, 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
AbstractDecoratorAction()
           
 
Method Summary
 String getContent()
           
 String getDecoratorName()
           
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, isAdminUser, isPersonalSpace, isSuperUser, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setThemeManager, setWikiStyleRenderer
 
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, 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
 
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!

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.



Copyright © 2003–2015 Atlassian. All rights reserved.