org.xwiki.rendering.block.FigureCaptionBlock 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.block;

import java.util.List;
import java.util.Map;

import org.xwiki.rendering.listener.Listener;

/**
 * Represents a figure caption (similar to the HTML5 {@code } element). Needs to be a children of the
 * {@link FigureBlock} block (either the first children block or the last children block).
 *
 * @version $Id: 58fa11fdcebc519c757a703885fd80b81e3b485b $
 * @since 10.2
 */
public class FigureCaptionBlock extends AbstractBlock
{
    /**
     * @param blocks the children blocks of the figure caption
     */
    public FigureCaptionBlock(List blocks)
    {
        super(blocks);
    }

    /**
     * @param blocks the children blocks of the figure caption
     * @param parameters the parameters of the figure caption
     */
    public FigureCaptionBlock(List blocks, Map parameters)
    {
        super(blocks, parameters);
    }

    @Override
    public void before(Listener listener)
    {
        listener.beginFigureCaption(getParameters());
    }

    @Override
    public void after(Listener listener)
    {
        listener.endFigureCaption(getParameters());
    }
}