com.itextpdf.layout.properties.grid.AutoRepeatValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of layout Show documentation
The newest version!
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2024 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.layout.properties.grid;

import java.util.List;

/**
 * This class represents an auto-repeat template value.
 * This value is preprocessed before grid sizing algorithm so its only exists at template level.
 */
public class AutoRepeatValue extends TemplateValue {
    private final List values;
    private final boolean autoFit;

    /**
     * Create a new auto-repeat value
     *
     * @param autoFit determines whether to shrink flatten template values to match the grid size
     * @param values template values to repeat
     */
    public AutoRepeatValue(boolean autoFit, List values) {
        super(ValueType.AUTO_REPEAT);
        this.values = values;
        this.autoFit = autoFit;
    }

    /**
     * Get template values which should be repeated.
     *
     * @return template values list
     */
    public List getValues() {
        return values;
    }

    /**
     * Determines whether to shrink flatten template values to match the grid size.
     *
     * @return {@code true} if to shrink, {@code false} otherwise
     */
    public boolean isAutoFit() {
        return autoFit;
    }
}