1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.macro.dashboard

File GadgetRenderer.java

 

Code metrics

0
0
0
1
44
9
0
-
-
0
-

Classes

Class Line # Actions
GadgetRenderer 35 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

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   
27    /**
28    * Decorates the passed gadget and renders it as a full piece of XDOM, a single list of blocks that can be added in the
29    * tree after.
30    *
31    * @version $Id: 07e3518773e5b87d42dea3936214a2c3a7e436c9 $
32    * @since 3.0rc1
33    */
34    @Role
 
35    public interface GadgetRenderer
36    {
37    /**
38    * Decorates the passed gadget and renders it as a list of XDOM blocks.
39    *
40    * @param gadget the gadget to render
41    * @return the list of blocks resulted from rendering the passed gadget and decorating it (with containers, etc)
42    */
43    List<Block> decorateGadget(Gadget gadget);
44    }