Package com.atlassian.confluence.plugins.labels.actions

Class ViewLabelAction

java.lang.Object
org.apache.struts2.ActionSupport
com.atlassian.confluence.core.AbstractI18nActionSupport
com.atlassian.confluence.core.ConfluenceActionSupport
com.atlassian.confluence.spaces.actions.AbstractSpaceAction
com.atlassian.confluence.plugins.labels.actions.AbstractLabelDisplayingAction
com.atlassian.confluence.plugins.labels.actions.ViewLabelAction
All Implemented Interfaces:
WebInterface, SpaceAware, Spaced, MessageHolderAware, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable
public class ViewLabelAction extends AbstractLabelDisplayingAction
Action for viewing a label. The label can be specified by either using the labels name(s) or the labels id(s), but not both.

The names and ids are the parameters passed in, and used for null-input validation, but are not "maintained" once the labels they point to are retrieved. This means that the names and ids fields have trivial state after retrieveLabels has been called and should not be accessed via getter methods.

See Also:

  • Field Details

    • ITEMS_PER_PAGE

      public static final int ITEMS_PER_PAGE
      The default number of content to be displayed on each page.
      See Also:

    • paginationSupport

      protected PaginationSupport paginationSupport
      Pagination support to assist in the display of the list of content associated with the label.

  • Constructor Details

    • ViewLabelAction

      public ViewLabelAction()

  • Method Details

    • setIds

      public void setIds(long[] ids)

    • setStartIndex

      public void setStartIndex(int startIndex)

    • setSearchManager

      public void setSearchManager(SearchManager searchManager)

    • getLabels

      public List<Label> getLabels()

    • getContent

      public List<Searchable> getContent()

    • getRelated

      public List<Label> getRelated()

    • getPaginationSupport

      public PaginationSupport getPaginationSupport()

    • validate

      public void validate()
      Specified by:
      validate in interface MessageHolderAware
      Specified by:
      validate in interface org.apache.struts2.Validateable
      Overrides:
      validate in class org.apache.struts2.ActionSupport

    • execute

      public String execute() throws Exception
      Specified by:
      execute in interface org.apache.struts2.action.Action
      Overrides:
      execute in class org.apache.struts2.ActionSupport
      Throws:
      Exception

    • isViewPermissionRequired

      public boolean isViewPermissionRequired()
      For viewing individual labels, we don't require view permission on any particular space (actually, this doesn't matter right now - but might in the future!)
      Specified by:
      isViewPermissionRequired in interface SpaceAware
      Overrides:
      isViewPermissionRequired in class AbstractLabelDisplayingAction
      Returns:
      true if the action requires view space permission

    • getOtherLabels

      public List<DisplayableLabel> getOtherLabels(Labelable content)
      Returns the first nine global labels on the given content that are not this.label. It is expected that the view will only display the first eight such labels, and use the ninth as a signal that a "..." is required
      Parameters:
      content - the content to get labels for
      Returns:
      a list of Labels with size between 0 and 8 inclusive. Not null.

    • getLabel

      public DisplayableLabel getLabel()
      Returns a DisplayableLabel based on all the labels being viewed.

    • getAddLabel

      public DisplayableLabel getAddLabel(Label label)
      Returns a DisplayableLabel representing the currently viewed labels and the given label.

      For example, if the current viewed labels are "a+b" and the passed label is "c", it returns a DisplayableLabel of "a+b+c"

      Sorts the labels by title before returning them, so the order is canonical.

    • getRemoveLabel

      public DisplayableLabel getRemoveLabel(Label label)
      Returns a DisplayableLabel representing the currently viewed labels, minus the given label.

      For example, if the current viewed labels are "a+b+c" and the passed label is "a", it returns a DisplayableLabel of "b+c"

      Sorts the labels by title before returning them, so the order is canonical.

    • getPaginationUrl

      public String getPaginationUrl()

    • getWebInterfaceContext

      public WebInterfaceContext getWebInterfaceContext()
      Description copied from interface: WebInterface
      Returns a context which can be passed to web items when rendering them.

      Typically, Struts actions will implement this to provide extra details in the context such as content objects, and so on.

      Specified by:
      getWebInterfaceContext in interface WebInterface
      Overrides:
      getWebInterfaceContext in class ConfluenceActionSupport

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getSiteSearchPermissionsQueryFactory

      public SiteSearchPermissionsQueryFactory getSiteSearchPermissionsQueryFactory()

    • setSiteSearchPermissionsQueryFactory

      public void setSiteSearchPermissionsQueryFactory(SiteSearchPermissionsQueryFactory siteSearchPermissionsQueryFactory)