com.atlassian.confluence.labels.actions
Class AbstractLabelDisplayingAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.confluence.core.ConfluenceActionSupport
          extended by com.atlassian.confluence.labels.actions.AbstractLabelDisplayingAction
All Implemented Interfaces:
WebInterface, SpaceAware, 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:
AlphabeticalListLabelsAction, RankListLabelsAction, ViewLabelAction

public class AbstractLabelDisplayingAction
extends ConfluenceActionSupport
implements SpaceAware

A nice abstract class for actions which display label/s on a global AND per space basis.

See Also:
Serialized Form

Field Summary
static int MAX_LABELS
           
protected  Space space
           
 
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
AbstractLabelDisplayingAction()
           
 
Method Summary
 List<Label> getPopularLabels()
           
 List<Label> getRecentLabels()
           
 Space getSpace()
           
 boolean isSpaceRequired()
          If the action requires that the space be set before being run, then it should return true to this method.
 boolean isViewPermissionRequired()
           
 void setSpace(Space space)
          IOC method for setting the space on the action.
 
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, isPermitted, 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, 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

space

protected Space space

MAX_LABELS

public static final int MAX_LABELS
See Also:
Constant Field Values
Constructor Detail

AbstractLabelDisplayingAction

public AbstractLabelDisplayingAction()
Method Detail

getSpace

public Space getSpace()
Specified by:
getSpace in interface Spaced

setSpace

public void setSpace(Space space)
Description copied from interface: SpaceAware
IOC method for setting the space on the action. This is called from the interceptor

Specified by:
setSpace in interface SpaceAware
Parameters:
space - the space that the action will be working on.

isSpaceRequired

public boolean isSpaceRequired()
Description copied from interface: SpaceAware
If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:
isSpaceRequired in interface SpaceAware
Returns:
true if the action requires a space in order to execute

isViewPermissionRequired

public boolean isViewPermissionRequired()
Specified by:
isViewPermissionRequired in interface SpaceAware
Returns:
true if the action requires view space permission

getRecentLabels

public List<Label> getRecentLabels()

getPopularLabels

public List<Label> getPopularLabels()


Copyright © 2003-2012 Atlassian. All Rights Reserved.