net.sf.dynamicreports.report.base.grid.DRColumnGridList 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.report.base.grid;

import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.constant.HorizontalCellComponentAlignment;
import net.sf.dynamicreports.report.constant.ListType;
import net.sf.dynamicreports.report.constant.VerticalCellComponentAlignment;
import net.sf.dynamicreports.report.definition.grid.DRIColumnGridComponent;
import net.sf.dynamicreports.report.definition.grid.DRIColumnGridList;
import org.apache.commons.lang3.Validate;

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

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

    private List listCells;
    private ListType type;
    private int gap;

    /**
     * Constructor for DRColumnGridList.
     */
    public DRColumnGridList() {
        this(ListType.HORIZONTAL);
    }

    /**
     * Constructor for DRColumnGridList.
     *
     * @param type a {@link net.sf.dynamicreports.report.constant.ListType} object.
     */
    public DRColumnGridList(ListType type) {
        setType(type);
        this.listCells = new ArrayList();
    }

    /** {@inheritDoc} */
    @Override
    public List getListCells() {
        return listCells;
    }

    /**
     * addComponent.
     *
     * @param component a {@link net.sf.dynamicreports.report.definition.grid.DRIColumnGridComponent} object.
     */
    public void addComponent(DRIColumnGridComponent component) {
        listCells.add(new DRColumnGridListCell(component));
    }

    /**
     * addCell.
     *
     * @param cell a {@link net.sf.dynamicreports.report.base.grid.DRColumnGridListCell} object.
     */
    public void addCell(DRColumnGridListCell cell) {
        Validate.notNull(cell, "cell must not be null");
        listCells.add(cell);
    }

    /**
     * addComponent.
     *
     * @param horizontalAlignment a {@link net.sf.dynamicreports.report.constant.HorizontalCellComponentAlignment} object.
     * @param verticalAlignment   a {@link net.sf.dynamicreports.report.constant.VerticalCellComponentAlignment} object.
     * @param component           a {@link net.sf.dynamicreports.report.definition.grid.DRIColumnGridComponent} object.
     */
    public void addComponent(HorizontalCellComponentAlignment horizontalAlignment, VerticalCellComponentAlignment verticalAlignment, DRIColumnGridComponent component) {
        listCells.add(new DRColumnGridListCell(horizontalAlignment, verticalAlignment, component));
    }

    /** {@inheritDoc} */
    @Override
    public ListType getType() {
        return type;
    }

    /**
     * Setter for the field type.
     *
     * @param type a {@link net.sf.dynamicreports.report.constant.ListType} object.
     */
    public void setType(ListType type) {
        Validate.notNull(type, "type must not be null");
        this.type = type;
    }

    /** {@inheritDoc} */
    @Override
    public int getGap() {
        return gap;
    }

    /**
     * Setter for the field gap.
     *
     * @param gap a int.
     */
    public void setGap(int gap) {
        Validate.notNull(gap < 0, "gap must be >= 0");
        this.gap = gap;
    }
}