net.sf.dynamicreports.design.base.DRDesignGroup Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dynamicreports-core Show documentation
DynamicReports is an open source Java reporting library based on JasperReports. It allows to create dynamic report designs and it doesn't need a visual report designer. You can very quickly create reports and produce documents that can be displayed, printed or exported into many popular formats such as PDF, Excel, Word and others.
The newest version!
/*
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2018 Ricardo Mariaca and the Dynamic Reports Contributors
 *
 * This file is part of DynamicReports.
 *
 * DynamicReports 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 3 of the License, or
 * (at your option) any later version.
 *
 * DynamicReports 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 DynamicReports. If not, see .
 */
package net.sf.dynamicreports.design.base;

import net.sf.dynamicreports.design.definition.DRIDesignGroup;
import net.sf.dynamicreports.design.definition.expression.DRIDesignExpression;
import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.constant.GroupFooterPosition;

import java.util.ArrayList;
import java.util.List;

/**
 * DRDesignGroup class.
 *
 * @author Ricardo Mariaca
 * 
 */
public class DRDesignGroup implements DRIDesignGroup {
    private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;

    private String name;
    private DRIDesignExpression groupExpression;
    private List headerBands;
    private List footerBands;
    private boolean startInNewPage;
    private boolean startInNewColumn;
    private boolean reprintHeaderOnEachPage;
    private boolean resetPageNumber;
    private Integer minHeightToStartNewPage;
    private GroupFooterPosition footerPosition;
    private boolean keepTogether;
    private boolean headerWithSubtotal;

    /**
     * Constructor for DRDesignGroup.
     *
     * @param name a {@link java.lang.String} object.
     */
    public DRDesignGroup(String name) {
        this.name = name;
        init();
    }

    private void init() {
        headerBands = new ArrayList();
        footerBands = new ArrayList();
    }

    /** {@inheritDoc} */
    @Override
    public String getName() {
        return name;
    }

    /** {@inheritDoc} */
    @Override
    public DRIDesignExpression getGroupExpression() {
        return groupExpression;
    }

    /**
     * Setter for the field groupExpression.
     *
     * @param groupExpression a {@link net.sf.dynamicreports.design.definition.expression.DRIDesignExpression} object.
     */
    public void setGroupExpression(DRIDesignExpression groupExpression) {
        this.groupExpression = groupExpression;
    }

    /** {@inheritDoc} */
    @Override
    public List getHeaderBands() {
        return headerBands;
    }

    /**
     * Setter for the field headerBands.
     *
     * @param headerBands a {@link java.util.List} object.
     */
    public void setHeaderBands(List headerBands) {
        this.headerBands = headerBands;
    }

    /**
     * addHeaderBand.
     *
     * @param headerBand a {@link net.sf.dynamicreports.design.base.DRDesignBand} object.
     */
    public void addHeaderBand(DRDesignBand headerBand) {
        this.headerBands.add(headerBand);
    }

    /** {@inheritDoc} */
    @Override
    public List getFooterBands() {
        return footerBands;
    }

    /**
     * Setter for the field footerBands.
     *
     * @param footerBands a {@link java.util.List} object.
     */
    public void setFooterBands(List footerBands) {
        this.footerBands = footerBands;
    }

    /**
     * addFooterBand.
     *
     * @param footerBand a {@link net.sf.dynamicreports.design.base.DRDesignBand} object.
     */
    public void addFooterBand(DRDesignBand footerBand) {
        this.footerBands.add(footerBand);
    }

    /**
     * addFooterBand.
     *
     * @param index      a int.
     * @param footerBand a {@link net.sf.dynamicreports.design.base.DRDesignBand} object.
     */
    public void addFooterBand(int index, DRDesignBand footerBand) {
        this.footerBands.add(index, footerBand);
    }

    /** {@inheritDoc} */
    @Override
    public boolean isStartInNewPage() {
        return startInNewPage;
    }

    /**
     * Setter for the field startInNewPage.
     *
     * @param startInNewPage a boolean.
     */
    public void setStartInNewPage(boolean startInNewPage) {
        this.startInNewPage = startInNewPage;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isStartInNewColumn() {
        return startInNewColumn;
    }

    /**
     * Setter for the field startInNewColumn.
     *
     * @param startInNewColumn a boolean.
     */
    public void setStartInNewColumn(boolean startInNewColumn) {
        this.startInNewColumn = startInNewColumn;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isReprintHeaderOnEachPage() {
        return reprintHeaderOnEachPage;
    }

    /**
     * Setter for the field reprintHeaderOnEachPage.
     *
     * @param reprintHeaderOnEachPage a boolean.
     */
    public void setReprintHeaderOnEachPage(boolean reprintHeaderOnEachPage) {
        this.reprintHeaderOnEachPage = reprintHeaderOnEachPage;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isResetPageNumber() {
        return resetPageNumber;
    }

    /**
     * Setter for the field resetPageNumber.
     *
     * @param resetPageNumber a boolean.
     */
    public void setResetPageNumber(boolean resetPageNumber) {
        this.resetPageNumber = resetPageNumber;
    }

    /** {@inheritDoc} */
    @Override
    public Integer getMinHeightToStartNewPage() {
        return minHeightToStartNewPage;
    }

    /**
     * Setter for the field minHeightToStartNewPage.
     *
     * @param minHeightToStartNewPage a {@link java.lang.Integer} object.
     */
    public void setMinHeightToStartNewPage(Integer minHeightToStartNewPage) {
        this.minHeightToStartNewPage = minHeightToStartNewPage;
    }

    /** {@inheritDoc} */
    @Override
    public GroupFooterPosition getFooterPosition() {
        return footerPosition;
    }

    /**
     * Setter for the field footerPosition.
     *
     * @param footerPosition a {@link net.sf.dynamicreports.report.constant.GroupFooterPosition} object.
     */
    public void setFooterPosition(GroupFooterPosition footerPosition) {
        this.footerPosition = footerPosition;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isKeepTogether() {
        return keepTogether;
    }

    /**
     * Setter for the field keepTogether.
     *
     * @param keepTogether a boolean.
     */
    public void setKeepTogether(boolean keepTogether) {
        this.keepTogether = keepTogether;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isHeaderWithSubtotal() {
        return headerWithSubtotal;
    }

    /**
     * Setter for the field headerWithSubtotal.
     *
     * @param headerWithSubtotal a boolean.
     */
    public void setHeaderWithSubtotal(boolean headerWithSubtotal) {
        this.headerWithSubtotal = headerWithSubtotal;
    }

}