org.xwiki.rendering.macro.toc.TocMacroParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-macro-toc Show documentation
Generates a Table Of Content for titles (headings)
The newest version!
/*
 * 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.macro.toc;

import javax.validation.constraints.Min;

import org.xwiki.properties.annotation.PropertyAdvanced;
import org.xwiki.properties.annotation.PropertyDescription;

/**
 * Parameters for the {@link org.xwiki.rendering.internal.macro.toc.TocMacro} Macro.
 *
 * @version $Id: 8b7c2837cf202890f5bf87707eb063fe89d6a658 $
 * @since 1.6M1
 */
public class TocMacroParameters
{
    /**
     * @version $Id: 8b7c2837cf202890f5bf87707eb063fe89d6a658 $
     */
    public enum Scope
    {
        /**
         * List section starting where macro block is located in the XDOM.
         */
        LOCAL,

        /**
         * List the sections of the whole page.
         */
        PAGE
    }

    /**
     * The minimum section level. For example if 2 then level 1 sections will not be listed.
     */
    @Min(1)
    private int start = 1;

    /**
     * Indicate if the start parameter has been set by the user or if it has the default value.
     */
    private boolean customStart;

    /**
     * The maximum section level. For example if 3 then all section levels from 4 will not be listed.
     */
    @Min(1)
    private int depth = 6;

    /**
     * If local only section in the current scope will be listed. For example if the macro is written in a section, only
     * subsections of this section will be listed.
     */
    private Scope scope = Scope.PAGE;

    /**
     * If true the section title number is printed.
     */
    private boolean numbered;

    private String reference;

    /**
     * @param start the minimum section level. For example if 2 then level 1 sections will not be listed.
     */
    @PropertyDescription("the minimum section level. For example if 2 then level 1 sections will not be listed")
    public void setStart(int start)
    {
        this.start = start;
        this.customStart = true;
    }

    /**
     * @return the minimum section level. For example if 2 then level 1 sections will not be listed.
     */
    public int getStart()
    {
        return this.start;
    }

    /**
     * @return indicate if the start has been set or if it has the default value.
     */
    public boolean isCustomStart()
    {
        return this.customStart;
    }

    /**
     * @param depth the maximum section level. For example if 3 then all section levels from 4 will not be listed.
     */
    @PropertyDescription("the maximum section level. "
        + "For example if 3 then all section levels from 4 will not be listed")
    public void setDepth(int depth)
    {
        this.depth = depth;
    }

    /**
     * @return the maximum section level. For example if 3 then all section levels from 4 will not be listed.
     */
    public int getDepth()
    {
        return this.depth;
    }

    /**
     * @param scope If local only section in the current scope will be listed. For example if the macro is written in a
     *            section, only subsections of this section will be listed.
     */
    @PropertyDescription("if local only section in the current scope will be listed. "
        + "For example if the macro is written in a section, only subsections of this section will be listed")
    public void setScope(Scope scope)
    {
        this.scope = scope;
    }

    /**
     * @return if {@link Scope#LOCAL} only section in the current scope will be listed. For example if the macro is
     *         written in a section, only subsections of this section will be listed.
     */
    public Scope getScope()
    {
        return this.scope;
    }

    /**
     * @param numbered if true the section title number is printed.
     */
    @PropertyDescription("if true the section title number is printed")
    @PropertyAdvanced
    public void setNumbered(boolean numbered)
    {
        this.numbered = numbered;
    }

    /**
     * @return if true the section title number is printed.
     */
    public boolean isNumbered()
    {
        return this.numbered;
    }

    /**
     * @param reference the reference to the document for which to generate the table of content. If not defined, then
     *                  the current document is used
     */
    @PropertyDescription("the reference to the document for which to generate the table of contents. "
        + "Leave empty for the current page")
    public void setReference(String reference)
    {
        this.reference = reference;
    }

    /**
     * @return the reference to the document for which to generate the table of content
     */
    public String getReference()
    {
        return this.reference;
    }
}