org.xwiki.rendering.internal.transformation.MutableRenderingContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-api Show documentation
XWiki Rendering - Api
There is a newer version: 16.9.0
/*
 * 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.internal.transformation;

import org.xwiki.rendering.block.Block;
import org.xwiki.rendering.block.XDOM;
import org.xwiki.rendering.syntax.Syntax;
import org.xwiki.rendering.transformation.RenderingContext;
import org.xwiki.rendering.transformation.Transformation;
import org.xwiki.rendering.transformation.TransformationContext;
import org.xwiki.rendering.transformation.TransformationException;

/**
 * An interface to update the rendering context internally during transformations.
 *
 * @version $Id: 170804298991075bbaa88357c299b5c44e15f414 $
 * @since 6.0RC1
 */
public interface MutableRenderingContext extends RenderingContext
{
    /**
     * Push a new rendering context.
     *
     * @param transformation the transformation being performed.
     * @param context the transformation context.
     */
    void push(Transformation transformation, TransformationContext context);

    /**
     * Push a new rendering context.
     *
     * @param transformation the transformation being performed.
     * @param xdom the complete XDOM being processed.
     * @param syntax the current syntax.
     * @param transformationId the id of the transformation.
     * @param restricted true if the transformation is restricted.
     * @param targetSyntax the syntax of the renderer
     */
    void push(Transformation transformation, XDOM xdom, Syntax syntax, String transformationId, boolean restricted,
        Syntax targetSyntax);

    /**
     * Pop the rendering context.
     */
    void pop();

    /**
     * Helper to run a transformation while properly updating the rendering context.
     *
     * @param transformation the transformation to apply.
     * @param context the transformation context.
     * @param block the block to apply the transformation on.
     * @throws TransformationException see {@link Transformation#transform(Block, TransformationContext)}.
     */
    void transformInContext(Transformation transformation, TransformationContext context, Block block)
        throws TransformationException;

    /**
     * Set the current block.
     *
     * @param block the block current being processed by the transformation.
     */
    void setCurrentBlock(Block block);

    /**
     * Set the target syntax.
     * 
     * @param targetSyntax the target syntax
     */
    void setTargetSyntax(Syntax targetSyntax);
}