Package com.atlassian.confluence.plugins.soy

Class PanelsForLocationFunction

java.lang.Object
com.atlassian.confluence.plugins.soy.PanelsForLocationFunction
All Implemented Interfaces:
com.atlassian.soy.renderer.SoyFunction, com.atlassian.soy.renderer.SoyServerFunction<Iterable<WebPanelView>>
public class PanelsForLocationFunction extends Object implements com.atlassian.soy.renderer.SoyServerFunction<Iterable<WebPanelView>>
A soy server function that retrieves web-panels for a given location.

Usage: {let $panels: panelsForLocation(contentId, 'system.main.nav') /}

where contentId is used to provide additional information to the WebInterfaceContext. Pass null if the panels are not associated with a specific CEO.

contentId has to be a string because soy can't deal with 64-bit longs. It might appear to work for you if your contentId is small enough to actually fit into an integer but it will blow up once it doesn't anymore.

  • Constructor Details

    • PanelsForLocationFunction

      public PanelsForLocationFunction(WebViewService webViewService)

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface com.atlassian.soy.renderer.SoyFunction

    • apply

      public Iterable<WebPanelView> apply(Object... args)
      Specified by:
      apply in interface com.atlassian.soy.renderer.SoyServerFunction<Iterable<WebPanelView>>

    • validArgSizes

      public Set<Integer> validArgSizes()
      Specified by:
      validArgSizes in interface com.atlassian.soy.renderer.SoyFunction