org.xwiki.rendering.internal.macro.dashboard
Class ColumnsDashboardRenderer

java.lang.Object
  org.xwiki.rendering.internal.macro.dashboard.ColumnsDashboardRenderer

All Implemented Interfaces:

DashboardRenderer

@Component(value="columns")
public class ColumnsDashboardRenderer
extends java.lang.Object
implements DashboardRenderer

The columns dashboard renderer, that renders the list of passed gadgets in columns, and interprets the positions as pairs of column number and gadget index.

Since:

3.0M3

Version:

$Id$

Field Summary

protected static java.lang.String	CLASS The HTML class attribute name.
protected static java.lang.String	ID The HTML id attribute name.

Constructor Summary

ColumnsDashboardRenderer()

Method Summary

java.util.List<Block>

renderGadgets(java.util.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS

protected static final java.lang.String CLASS

The HTML class attribute name.

See Also:

Constant Field Values

ID

protected static final java.lang.String ID

The HTML id attribute name.

See Also:

Constant Field Values

Constructor Detail

ColumnsDashboardRenderer

public ColumnsDashboardRenderer()

Method Detail

renderGadgets

public java.util.List<Block> renderGadgets(java.util.List<Gadget> gadgets,
                                           GadgetRenderer gadgetsRenderer,
                                           org.xwiki.rendering.transformation.MacroTransformationContext context)
                                    throws org.xwiki.rendering.macro.MacroExecutionException

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

Specified by:

renderGadgets in interface DashboardRenderer

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:

org.xwiki.rendering.macro.MacroExecutionException

See Also:

DashboardRenderer.renderGadgets(java.util.List, GadgetRenderer, MacroTransformationContext)