1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.rendering.internal.renderer.xhtml

File AnnotatedXHTMLRenderer.java

 

Coverage histogram

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

Code metrics

0
7
1
1
84
38
1
0.14
7
1
1

Classes

Class Line # Actions
AnnotatedXHTMLRenderer 50 7 0% 1 0
1.0100%
 

Contributing tests

This file is covered by 98 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.renderer.xhtml;
21   
22    import javax.inject.Inject;
23    import javax.inject.Named;
24   
25    import org.xwiki.component.annotation.Component;
26    import org.xwiki.component.annotation.InstantiationStrategy;
27    import org.xwiki.component.descriptor.ComponentInstantiationStrategy;
28    import org.xwiki.component.phase.Initializable;
29    import org.xwiki.component.phase.InitializationException;
30    import org.xwiki.rendering.internal.renderer.xhtml.image.XHTMLImageRenderer;
31    import org.xwiki.rendering.internal.renderer.xhtml.link.XHTMLLinkRenderer;
32    import org.xwiki.rendering.listener.chaining.BlockStateChainingListener;
33    import org.xwiki.rendering.listener.chaining.EmptyBlockChainingListener;
34    import org.xwiki.rendering.listener.chaining.ListenerChain;
35    import org.xwiki.rendering.listener.chaining.MetaDataStateChainingListener;
36    import org.xwiki.rendering.renderer.AbstractChainingPrintRenderer;
37   
38    /**
39    * Generates Annotated XHTML (ie XHTML containing metadata information, for example macro definition or
40    * link definition) from a {@link org.xwiki.rendering.block.XDOM} object being traversed.
41    * The annotations allow initial source content to be fully reconstructed from the generated XHTML. This is required
42    * for example for doing round tripping between wiki syntax and XHTML syntax in the WYSIWYG editor.
43    *
44    * @version $Id: b182ac6545d3fae79733ed6437248a0ae063709b $
45    * @since 2.0M3
46    */
47    @Component
48    @Named("annotatedxhtml/1.0")
49    @InstantiationStrategy(ComponentInstantiationStrategy.PER_LOOKUP)
 
50    public class AnnotatedXHTMLRenderer extends AbstractChainingPrintRenderer implements Initializable
51    {
52    /**
53    * To render link events into annotated XHTML. This is done so that it's pluggable because link rendering depends
54    * on how the underlying system wants to handle it. For example for XWiki we check if the document exists, we get
55    * the document URL, etc.
56    */
57    @Inject
58    @Named("annotated")
59    private XHTMLLinkRenderer linkRenderer;
60   
61    /**
62    * To render image events into annotated XHTML. This is done so that it's pluggable because image rendering depends
63    * on how the underlying system wants to handle it. For example for XWiki we check if the image exists as a
64    * document attachments, we get its URL, etc.
65    */
66    @Inject
67    @Named("annotated")
68    private XHTMLImageRenderer imageRenderer;
69   
 
70  122 toggle @Override
71    public void initialize() throws InitializationException
72    {
73  122 ListenerChain chain = new ListenerChain();
74  122 setListenerChain(chain);
75   
76    // Construct the listener chain in the right order. Listeners early in the chain are called before listeners
77    // placed later in the chain.
78  122 chain.addListener(this);
79  122 chain.addListener(new BlockStateChainingListener(chain));
80  122 chain.addListener(new EmptyBlockChainingListener(chain));
81  122 chain.addListener(new MetaDataStateChainingListener(chain));
82  122 chain.addListener(new AnnotatedXHTMLChainingRenderer(this.linkRenderer, this.imageRenderer, chain));
83    }
84    }