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

File PrintRenderer.java

 

Code metrics

0
0
0
1
45
9
0
-
-
0
-

Classes

Class Line # Actions
PrintRenderer 32 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.renderer;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.rendering.renderer.printer.WikiPrinter;
24   
25    /**
26    * A Print Renderer is a {@link Renderer} that outputs its results to a {@link WikiPrinter}.
27    *
28    * @version $Id: a0330d7315f17d6569fd047d19c77dd39b2305be $
29    * @since 1.6M1
30    */
31    @Role
 
32    public interface PrintRenderer extends Renderer
33    {
34    /**
35    * @return the printer to which events generate results in. For example the XHTML print renderer outputs XHTML to a
36    * {@link WikiPrinter} and the resulting XHTML can be retrieved by calling {@code toString()} on it
37    */
38    WikiPrinter getPrinter();
39   
40    /**
41    * @param printer the wiki printer to use when the Renderer needs to output rendered content
42    * @since 2.0M3
43    */
44    void setPrinter(WikiPrinter printer);
45    }