Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
DashboardRenderer	36	0	-	0	0	-1.0 -	Show methods

Class DashboardRenderer

Class DashboardRenderer	Line # 36	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.rendering.macro.dashboard;
21
22		import java.util.List;
23
24		import org.xwiki.component.annotation.Role;
25		import org.xwiki.rendering.block.Block;
26		import org.xwiki.rendering.transformation.MacroTransformationContext;
27
28		/**
29		* Renders the passed list of gadgets as a piece of XDOM, to be added in a tree after, handling the layout of the
30		* gadgets. Various implementations of this class should provide various strategies of layouting the gadgets.
31		*
32		* @version $Id: 226c6de6968ca724e279f00c96a818c95209c561 $
33		* @since 3.0M3
34		*/
35		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
36		public interface DashboardRenderer
37		{
38		/**
39		* Renders the passed gadgets in a list of blocks, to be added in an XDOM and rendered after.
40		*
41		* @param gadgets the gadgets to render as XDOM
42		* @param gadgetsRenderer the renderer to use to render the gadgets
43		* @param context the macro transformation context where the dashboard is executed
44		* @return the list of {@link Block}s that represent the gadgets list
45		* @throws Exception if anything goes wrong during macro execution
46		*/
47		List<Block> renderGadgets(List<Gadget> gadgets, GadgetRenderer gadgetsRenderer, MacroTransformationContext context)
48		throws Exception;
49
50		// TODO: add here function that takes dashboard layout specification string as param, to allow different layout
51		// types
52		}