org.randombits.support.confluence.style

Class StyleAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

org.randombits.support.confluence.style.StyleAction

All Implemented Interfaces:

com.atlassian.confluence.plugin.descriptor.web.WebInterface, com.atlassian.confluence.spaces.actions.SpaceAware, com.atlassian.confluence.spaces.Spaced, com.atlassian.confluence.validation.MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, java.io.Serializable

public class StyleAction
extends com.atlassian.confluence.core.ConfluenceActionSupport
implements com.atlassian.confluence.spaces.actions.SpaceAware

This is an action which will render a CSS/VM file appropriately for Confluence. It is pre-populated with useful helpers for style and theme information.

To add it to your plugin, put something like this in your atlassian-plugin.xml file:

  <xwork name="Extra Plugin Actions" key="extraPluginActions">
  <package name="scaffold" extends="default" namespace="/plugins/yourplugin">
  <default-interceptor-ref name="defaultStack"/>
 
  <action name="style" class="net.customware.confluence.support.style.StyleAction">
  <result name="success" type="velocity-css">/path/to/css/style.css.vm</result>
  </action>    
  </package>
  </xwork>
 

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

Constructors

Constructor and Description
StyleAction()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	execute()
java.lang.String	getBorderColor()
java.lang.String	getBorderColour()
java.lang.String	getBreadcrumbsTextColour()
java.lang.String	getCustomColor1()
java.lang.String	getCustomColor2()
java.lang.String	getCustomColor3()
java.lang.String	getCustomColor4()
java.lang.String	getCustomColor5()
java.lang.String	getHeadingTextColor()
java.lang.String	getHeadingTextColour()
java.lang.String	getLinkColor()
java.lang.String	getLinkColour()
java.lang.String	getMenuItemSelctedTextColor()
java.lang.String	getMenuItemSelectedBackgroundColor()
java.lang.String	getMenuItemTextColor()
java.lang.String	getMenuSelectedBackgroundColor()
java.lang.String	getNavBackgroundColor()
java.lang.String	getNavBackgroundColour()
java.lang.String	getNavSelectedBackgroundColor()
java.lang.String	getNavSelectedBackgroundColour()
java.lang.String	getNavSelectedTextColor()
java.lang.String	getNavSelectedTextColour()
java.lang.String	getNavTextColor()
java.lang.String	getNavTextColour()
com.atlassian.confluence.spaces.Space	getSpace()
java.lang.String	getSpaceKey()
java.lang.String	getSpaceNameColor()
java.lang.String	getSpaceNameColour()
com.atlassian.confluence.themes.Theme	getTheme()
java.lang.String	getTopBarColor()
java.lang.String	getTopBarColour()
java.lang.String	getTopBarMenuItemSelectedBackgroundColor()
java.lang.String	getTopBarMenuItemTextColor()
boolean	isPermitted()
boolean	isSpaceRequired()
boolean	isViewPermissionRequired()
void	setColourSchemeManager(com.atlassian.confluence.themes.ColourSchemeManager colourSchemeManager)
void	setSpace(com.atlassian.confluence.spaces.Space space)
void	setThemeManager(com.atlassian.confluence.themes.ThemeManager themeManager)

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, 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, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, 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

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

validate

Constructor Detail

StyleAction

public StyleAction()

Method Detail

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class com.atlassian.confluence.core.ConfluenceActionSupport

execute

public java.lang.String execute()

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

getTheme

public com.atlassian.confluence.themes.Theme getTheme()

getTopBarColor

public java.lang.String getTopBarColor()

getBreadcrumbsTextColour

public java.lang.String getBreadcrumbsTextColour()

getSpaceNameColor

public java.lang.String getSpaceNameColor()

getHeadingTextColor

public java.lang.String getHeadingTextColor()

getLinkColor

public java.lang.String getLinkColor()

getBorderColor

public java.lang.String getBorderColor()

getNavBackgroundColor

public java.lang.String getNavBackgroundColor()

getNavTextColor

public java.lang.String getNavTextColor()

getNavSelectedBackgroundColor

public java.lang.String getNavSelectedBackgroundColor()

getNavSelectedTextColor

public java.lang.String getNavSelectedTextColor()

getCustomColor1

public java.lang.String getCustomColor1()

getCustomColor2

public java.lang.String getCustomColor2()

getCustomColor3

public java.lang.String getCustomColor3()

getCustomColor4

public java.lang.String getCustomColor4()

getCustomColor5

public java.lang.String getCustomColor5()

getTopBarColour

public java.lang.String getTopBarColour()

getSpaceNameColour

public java.lang.String getSpaceNameColour()

getHeadingTextColour

public java.lang.String getHeadingTextColour()

getLinkColour

public java.lang.String getLinkColour()

getBorderColour

public java.lang.String getBorderColour()

getNavBackgroundColour

public java.lang.String getNavBackgroundColour()

getNavTextColour

public java.lang.String getNavTextColour()

getNavSelectedBackgroundColour

public java.lang.String getNavSelectedBackgroundColour()

getNavSelectedTextColour

public java.lang.String getNavSelectedTextColour()

getMenuItemSelectedBackgroundColor

public java.lang.String getMenuItemSelectedBackgroundColor()

getMenuItemSelctedTextColor

public java.lang.String getMenuItemSelctedTextColor()

getMenuItemTextColor

public java.lang.String getMenuItemTextColor()

getMenuSelectedBackgroundColor

public java.lang.String getMenuSelectedBackgroundColor()

getTopBarMenuItemTextColor

public java.lang.String getTopBarMenuItemTextColor()

getTopBarMenuItemSelectedBackgroundColor

public java.lang.String getTopBarMenuItemSelectedBackgroundColor()

setColourSchemeManager

public void setColourSchemeManager(com.atlassian.confluence.themes.ColourSchemeManager colourSchemeManager)

setThemeManager

public void setThemeManager(com.atlassian.confluence.themes.ThemeManager themeManager)

isSpaceRequired

public boolean isSpaceRequired()

Specified by:

isSpaceRequired in interface com.atlassian.confluence.spaces.actions.SpaceAware

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface com.atlassian.confluence.spaces.actions.SpaceAware

getSpaceKey

public java.lang.String getSpaceKey()

setSpace

public void setSpace(com.atlassian.confluence.spaces.Space space)

Specified by:

setSpace in interface com.atlassian.confluence.spaces.actions.SpaceAware

getSpace

public com.atlassian.confluence.spaces.Space getSpace()

Specified by:

getSpace in interface com.atlassian.confluence.spaces.Spaced