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

File IdMacro.java

 

Coverage histogram

../../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
6
3
1
81
39
3
0.5
2
3
1

Classes

Class Line # Actions
IdMacro 46 6 0% 3 0
1.0100%
 

Contributing tests

This file is covered by 6 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.internal.macro.id;
21   
22    import java.util.Collections;
23    import java.util.List;
24   
25    import javax.inject.Named;
26    import javax.inject.Singleton;
27   
28    import org.xwiki.component.annotation.Component;
29    import org.xwiki.rendering.block.Block;
30    import org.xwiki.rendering.block.IdBlock;
31    import org.xwiki.rendering.macro.AbstractMacro;
32    import org.xwiki.rendering.macro.MacroExecutionException;
33    import org.xwiki.rendering.macro.id.IdMacroParameters;
34    import org.xwiki.rendering.transformation.MacroTransformationContext;
35   
36    /**
37    * Allows putting a reference/location in a page. In HTML for example this is called an Anchor. It allows pointing to
38    * that location, for example in links.
39    *
40    * @version $Id: 343ab46f5b25d8b3c21e8c8de3332f15100dd800 $
41    * @since 1.6M1
42    */
43    @Component
44    @Named("id")
45    @Singleton
 
46    public class IdMacro extends AbstractMacro<IdMacroParameters>
47    {
48    /**
49    * The description of the macro.
50    */
51    private static final String DESCRIPTION =
52    "Allows putting a reference/location in a page." + " In HTML for example this is called an Anchor."
53    + " It allows pointing to that location, for example in links.";
54   
55    /**
56    * Create and initialize the descriptor of the macro.
57    */
 
58  6 toggle public IdMacro()
59    {
60  6 super("Id", DESCRIPTION, IdMacroParameters.class);
61   
62    // Set a high priority so that this macro executes before most others.
63  6 setPriority(20);
64  6 setDefaultCategory(DEFAULT_CATEGORY_NAVIGATION);
65    }
66   
 
67  4 toggle @Override
68    public boolean supportsInlineMode()
69    {
70  4 return true;
71    }
72   
 
73  6 toggle @Override
74    public List<Block> execute(IdMacroParameters parameters, String content, MacroTransformationContext context)
75    throws MacroExecutionException
76    {
77  6 IdBlock idBlock = new IdBlock(parameters.getName());
78   
79  6 return Collections.singletonList((Block) idBlock);
80    }
81    }