File DefaultBoxMacro.java
Coverage histogram
0% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| DefaultBoxMacro | 45 | 3 | 0% | 2 | 0 |
Contributing tests
This file is covered by 21 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.box; | |
| 21 | ||
| 22 | import java.util.List; | |
| 23 | ||
| 24 | import javax.inject.Named; | |
| 25 | import javax.inject.Singleton; | |
| 26 | ||
| 27 | import org.xwiki.component.annotation.Component; | |
| 28 | import org.xwiki.rendering.block.Block; | |
| 29 | import org.xwiki.rendering.macro.MacroExecutionException; | |
| 30 | import org.xwiki.rendering.macro.box.AbstractBoxMacro; | |
| 31 | import org.xwiki.rendering.macro.box.BoxMacroParameters; | |
| 32 | import org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor; | |
| 33 | import org.xwiki.rendering.transformation.MacroTransformationContext; | |
| 34 | ||
| 35 | /** | |
| 36 | * Draw a box around provided content. | |
| 37 | * | |
| 38 | * @param <P> the type of macro parameters bean. | |
| 39 | * @version $Id: 81db4c7e305d61b66624b752406acecf65884d71 $ | |
| 40 | * @since 1.7 | |
| 41 | */ | |
| 42 | @Component | |
| 43 | @Named("box") | |
| 44 | @Singleton | |
| 45 | public class DefaultBoxMacro<P extends BoxMacroParameters> extends AbstractBoxMacro<P> | |
| 46 | { | |
| 47 | /** | |
| 48 | * The description of the macro. | |
| 49 | */ | |
| 50 | private static final String DESCRIPTION = "Draw a box around provided content."; | |
| 51 | ||
| 52 | /** | |
| 53 | * The description of the macro content. | |
| 54 | */ | |
| 55 | private static final String CONTENT_DESCRIPTION = "the content to put in the box"; | |
| 56 | ||
| 57 | /** | |
| 58 | * Create and initialize the descriptor of the macro. | |
| 59 | */ | |
| 60 | 36 |  public DefaultBoxMacro() |
| 61 | { | |
| 62 | 36 | super("Box", DESCRIPTION, new DefaultContentDescriptor(CONTENT_DESCRIPTION), BoxMacroParameters.class); |
| 63 | 36 | setDefaultCategory(DEFAULT_CATEGORY_FORMATTING); |
| 64 | } | |
| 65 | ||
| 66 | 176 | @Override |
| 67 | protected List<Block> parseContent(P parameters, String content, MacroTransformationContext context) | |
| 68 | throws MacroExecutionException | |
| 69 | { | |
| 70 | // Don't execute transformations explicitly. They'll be executed on the generated content later on. | |
| 71 | 176 | return getMacroContentParser().parse(content, context, false, context.isInline()).getChildren(); |
| 72 | } | |
| 73 | } |