net.sf.dynamicreports.design.definition.component.DRIDesignComponent Maven / Gradle / Ivy

/*
 * 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.definition.component;

import net.sf.dynamicreports.design.definition.DRIDesignGroup;
import net.sf.dynamicreports.design.definition.DRIDesignTableOfContentsHeading;
import net.sf.dynamicreports.design.definition.expression.DRIDesignExpression;
import net.sf.dynamicreports.design.definition.expression.DRIDesignPropertyExpression;
import net.sf.dynamicreports.design.definition.style.DRIDesignStyle;
import net.sf.dynamicreports.report.constant.ComponentPositionType;
import net.sf.dynamicreports.report.constant.StretchType;

import java.io.Serializable;
import java.util.List;

/**
 * DRIDesignComponent interface.
 *
 * @author Ricardo Mariaca
 * 
 */
public interface DRIDesignComponent extends Serializable {
    /**
     * getName.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getName();

    /**
     * getUniqueName.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getUniqueName();

    /**
     * getStyle.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.style.DRIDesignStyle} object.
     */
    public DRIDesignStyle getStyle();

    /**
     * getX.
     *
     * @return a {@link java.lang.Integer} object.
     */
    public Integer getX();

    /**
     * getY.
     *
     * @return a {@link java.lang.Integer} object.
     */
    public Integer getY();

    /**
     * getWidth.
     *
     * @return a {@link java.lang.Integer} object.
     */
    public Integer getWidth();

    /**
     * getHeight.
     *
     * @return a {@link java.lang.Integer} object.
     */
    public Integer getHeight();

    /**
     * getPrintWhenExpression.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.expression.DRIDesignExpression} object.
     */
    public DRIDesignExpression getPrintWhenExpression();

    /**
     * isRemoveLineWhenBlank.
     *
     * @return a boolean.
     */
    public boolean isRemoveLineWhenBlank();

    /**
     * getPropertyExpressions.
     *
     * @return a {@link java.util.List} object.
     */
    public List getPropertyExpressions();

    /**
     * getPositionType.
     *
     * @return a {@link net.sf.dynamicreports.report.constant.ComponentPositionType} object.
     */
    public ComponentPositionType getPositionType();

    /**
     * getStretchType.
     *
     * @return a {@link net.sf.dynamicreports.report.constant.StretchType} object.
     */
    public StretchType getStretchType();

    /**
     * isPrintInFirstWholeBand.
     *
     * @return a boolean.
     */
    public boolean isPrintInFirstWholeBand();

    /**
     * isPrintWhenDetailOverflows.
     *
     * @return a boolean.
     */
    public boolean isPrintWhenDetailOverflows();

    /**
     * getPrintWhenGroupChanges.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignGroup} object.
     */
    public DRIDesignGroup getPrintWhenGroupChanges();

    /**
     * getTableOfContentsHeading.
     *
     * @return a {@link net.sf.dynamicreports.design.definition.DRIDesignTableOfContentsHeading} object.
     */
    public DRIDesignTableOfContentsHeading getTableOfContentsHeading();
}