Package org.xwiki.rendering.macro.dashboard

Interface DashboardRenderer

@Role
public interface DashboardRenderer

Renders the passed list of gadgets as a piece of XDOM, to be added in a tree after, handling the layout of the gadgets. Various implementations of this class should provide various strategies of layouting the gadgets.

Since:

3.0M3

Version:

$Id: 226c6de6968ca724e279f00c96a818c95209c561 $

Method Summary

Modifier and Type	Method	Description
List<org.xwiki.rendering.block.Block>	renderGadgets(List<Gadget> gadgets, GadgetRenderer gadgetsRenderer, org.xwiki.rendering.transformation.MacroTransformationContext context)	Renders the passed gadgets in a list of blocks, to be added in an XDOM and rendered after.

Method Details

renderGadgets

List<org.xwiki.rendering.block.Block> renderGadgets(List<Gadget> gadgets,
 GadgetRenderer gadgetsRenderer,
 org.xwiki.rendering.transformation.MacroTransformationContext context)
                                             throws Exception

Renders the passed gadgets in a list of blocks, to be added in an XDOM and rendered after.

Parameters:

gadgets - the gadgets to render as XDOM

gadgetsRenderer - the renderer to use to render the gadgets

context - the macro transformation context where the dashboard is executed

Returns:

the list of Blocks that represent the gadgets list

Throws:

Exception - if anything goes wrong during macro execution