public class

AbstractLabelDisplayingAction

extends ConfluenceActionSupport
implements SpaceAware
java.lang.Object
   ↳ com.opensymphony.xwork.ActionSupport
     ↳ com.atlassian.confluence.core.ConfluenceActionSupport
       ↳ com.atlassian.confluence.labels.actions.AbstractLabelDisplayingAction
Known Direct Subclasses

Class Overview

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

Summary

Constants
int MAX_LABELS
[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ConfluenceActionSupport
From interface com.opensymphony.xwork.Action
Fields
protected Space space
[Expand]
Inherited Fields
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
Public Constructors
AbstractLabelDisplayingAction()
Public Methods
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.
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.ConfluenceActionSupport
From class com.opensymphony.xwork.ActionSupport
From class java.lang.Object
From interface com.atlassian.confluence.plugin.descriptor.web.WebInterface
From interface com.atlassian.confluence.spaces.Spaced
From interface com.atlassian.confluence.spaces.actions.SpaceAware
From interface com.opensymphony.xwork.Action
From interface com.opensymphony.xwork.LocaleProvider
From interface com.opensymphony.xwork.TextProvider
From interface com.opensymphony.xwork.Validateable
From interface com.opensymphony.xwork.ValidationAware

Constants

public static final int MAX_LABELS

Constant Value: 15 (0x0000000f)

Fields

protected Space space

Public Constructors

public AbstractLabelDisplayingAction ()

Public Methods

public List<Label> getPopularLabels ()

public List<Label> getRecentLabels ()

public Space getSpace ()

public boolean isSpaceRequired ()

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

Returns
  • true if the action requires a space in order to execute

public boolean isViewPermissionRequired ()

public void setSpace (Space space)

IOC method for setting the space on the action. This is called from the interceptor

Parameters
space the space that the action will be working on.