org.xwiki.rendering.renderer.PrintRenderer Maven / Gradle / Ivy
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.rendering.renderer;
import org.xwiki.component.annotation.Role;
import org.xwiki.rendering.renderer.printer.WikiPrinter;
/**
* A Print Renderer is a {@link Renderer} that outputs its results to a {@link WikiPrinter}.
*
* @version $Id: a0330d7315f17d6569fd047d19c77dd39b2305be $
* @since 1.6M1
*/
@Role
public interface PrintRenderer extends Renderer
{
/**
* @return the printer to which events generate results in. For example the XHTML print renderer outputs XHTML to a
* {@link WikiPrinter} and the resulting XHTML can be retrieved by calling {@code toString()} on it
*/
WikiPrinter getPrinter();
/**
* @param printer the wiki printer to use when the Renderer needs to output rendered content
* @since 2.0M3
*/
void setPrinter(WikiPrinter printer);
}