net.sf.dynamicreports.report.definition.DRIReportTemplate Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamicreports-core Show documentation
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 DRIReportTemplate interface.
*
* @author Ricardo Mariaca
*
*/
public interface DRIReportTemplate extends Serializable {
/**
* getTemplateStyles.
*
* @return a {@link java.util.List} object.
*/
public List getTemplateStyles();
/**
* getLocale.
*
* @return a {@link java.util.Locale} object.
*/
public Locale getLocale();
/**
* getShowColumnTitle.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getShowColumnTitle();
/**
* getShowColumnValues.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getShowColumnValues();
/**
* getIgnorePagination.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getIgnorePagination();
/**
* getWhenNoDataType.
*
* @return a {@link net.sf.dynamicreports.report.constant.WhenNoDataType} object.
*/
public WhenNoDataType getWhenNoDataType();
/**
* getWhenResourceMissingType.
*
* @return a {@link net.sf.dynamicreports.report.constant.WhenResourceMissingType} object.
*/
public WhenResourceMissingType getWhenResourceMissingType();
/**
* getTitleOnANewPage.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getTitleOnANewPage();
/**
* getSummaryOnANewPage.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getSummaryOnANewPage();
/**
* getSummaryWithPageHeaderAndFooter.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getSummaryWithPageHeaderAndFooter();
/**
* getFloatColumnFooter.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getFloatColumnFooter();
/**
* getPrintOrder.
*
* @return a {@link net.sf.dynamicreports.report.constant.Orientation} object.
*/
public Orientation getPrintOrder();
/**
* getColumnDirection.
*
* @return a {@link net.sf.dynamicreports.report.constant.RunDirection} object.
*/
public RunDirection getColumnDirection();
/**
* getLanguage.
*
* @return a {@link java.lang.String} object.
*/
public String getLanguage();
/**
* getUseFieldNameAsDescription.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getUseFieldNameAsDescription();
/**
* getHighlightDetailOddRows.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getHighlightDetailOddRows();
/**
* getDetailOddRowStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRISimpleStyle} object.
*/
public DRISimpleStyle getDetailOddRowStyle();
/**
* getHighlightDetailEvenRows.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getHighlightDetailEvenRows();
/**
* getDetailEvenRowStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRISimpleStyle} object.
*/
public DRISimpleStyle getDetailEvenRowStyle();
/**
* getDefaultFont.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIFont} object.
*/
public DRIFont getDefaultFont();
/**
* getTextStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getTextStyle();
/**
* getColumnTitleStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getColumnTitleStyle();
/**
* getColumnStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getColumnStyle();
/**
* getGroupTitleStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getGroupTitleStyle();
/**
* getGroupStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getGroupStyle();
/**
* getSubtotalStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getSubtotalStyle();
/**
* getImageStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getImageStyle();
/**
* getChartStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getChartStyle();
/**
* getBarcodeStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getBarcodeStyle();
/**
* getPageWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getPageWidth();
/**
* getPageHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getPageHeight();
/**
* getPageOrientation.
*
* @return a {@link net.sf.dynamicreports.report.constant.PageOrientation} object.
*/
public PageOrientation getPageOrientation();
/**
* getPageMargin.
*
* @return a {@link net.sf.dynamicreports.report.definition.DRIMargin} object.
*/
public DRIMargin getPageMargin();
/**
* getPageColumnsPerPage.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getPageColumnsPerPage();
/**
* getPageColumnSpace.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getPageColumnSpace();
/**
* getIgnorePageWidth.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getIgnorePageWidth();
/**
* getColumnPrintRepeatedDetailValues.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getColumnPrintRepeatedDetailValues();
/**
* getColumnWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getColumnWidth();
/**
* getGroupHeaderLayout.
*
* @return a {@link net.sf.dynamicreports.report.constant.GroupHeaderLayout} object.
*/
public GroupHeaderLayout getGroupHeaderLayout();
/**
* getGroupHideColumn.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupHideColumn();
/**
* getGroupShowColumnHeaderAndFooter.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupShowColumnHeaderAndFooter();
/**
* getGroupPadding.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getGroupPadding();
/**
* getGroupStartInNewPage.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupStartInNewPage();
/**
* getGroupStartInNewColumn.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupStartInNewColumn();
/**
* getGroupReprintHeaderOnEachPage.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupReprintHeaderOnEachPage();
/**
* getGroupResetPageNumber.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupResetPageNumber();
/**
* getGroupFooterPosition.
*
* @return a {@link net.sf.dynamicreports.report.constant.GroupFooterPosition} object.
*/
public GroupFooterPosition getGroupFooterPosition();
/**
* getGroupKeepTogether.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupKeepTogether();
/**
* getGroupHeaderWithSubtotal.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getGroupHeaderWithSubtotal();
/**
* getSubtotalLabelPosition.
*
* @return a {@link net.sf.dynamicreports.report.constant.Position} object.
*/
public Position getSubtotalLabelPosition();
/**
* getTableOfContents.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getTableOfContents();
/**
* getTableOfContentsCustomizer.
*
* @return a {@link net.sf.dynamicreports.report.definition.DRITableOfContentsCustomizer} object.
*/
public DRITableOfContentsCustomizer getTableOfContentsCustomizer();
/**
* getTextFieldWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getTextFieldWidth();
/**
* getImageHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getImageHeight();
/**
* getImageWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getImageWidth();
/**
* getListgap.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getListgap();
/**
* getMultiPageListHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getMultiPageListHeight();
/**
* getMultiPageListWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getMultiPageListWidth();
/**
* getChartHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getChartHeight();
/**
* getChartWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getChartWidth();
/**
* getBarcodeHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getBarcodeHeight();
/**
* getBarcodeWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getBarcodeWidth();
/**
* getSubreportHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getSubreportHeight();
/**
* getSubreportWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getSubreportWidth();
/**
* getCrosstabHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getCrosstabHeight();
/**
* getCrosstabWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getCrosstabWidth();
/**
* getCrosstabHighlightOddRows.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getCrosstabHighlightOddRows();
/**
* getCrosstabOddRowStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRISimpleStyle} object.
*/
public DRISimpleStyle getCrosstabOddRowStyle();
/**
* getCrosstabHighlightEvenRows.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getCrosstabHighlightEvenRows();
/**
* getCrosstabEvenRowStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRISimpleStyle} object.
*/
public DRISimpleStyle getCrosstabEvenRowStyle();
/**
* getCrosstabGroupStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getCrosstabGroupStyle();
/**
* getCrosstabGroupTotalStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getCrosstabGroupTotalStyle();
/**
* getCrosstabGrandTotalStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getCrosstabGrandTotalStyle();
/**
* getCrosstabCellStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getCrosstabCellStyle();
/**
* getCrosstabMeasureTitleStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getCrosstabMeasureTitleStyle();
/**
* getChartSeriesColors.
*
* @return a {@link java.util.List} object.
*/
public List getChartSeriesColors();
/**
* getChartValuePattern.
*
* @return a {@link java.lang.String} object.
*/
public String getChartValuePattern();
/**
* getChartPercentValuePattern.
*
* @return a {@link java.lang.String} object.
*/
public String getChartPercentValuePattern();
/**
* getChartTheme.
*
* @return a {@link java.lang.String} object.
*/
public String getChartTheme();
/**
* getBooleanComponentType.
*
* @return a {@link net.sf.dynamicreports.report.constant.BooleanComponentType} object.
*/
public BooleanComponentType getBooleanComponentType();
/**
* getBooleanEmptyWhenNullValue.
*
* @return a {@link java.lang.Boolean} object.
*/
public Boolean getBooleanEmptyWhenNullValue();
/**
* getBooleanImageWidth.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getBooleanImageWidth();
/**
* getBooleanImageHeight.
*
* @return a {@link java.lang.Integer} object.
*/
public Integer getBooleanImageHeight();
/**
* getBooleanColumnStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getBooleanColumnStyle();
/**
* getDefaultSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getDefaultSplitType();
/**
* getTitleSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getTitleSplitType();
/**
* getPageHeaderSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getPageHeaderSplitType();
/**
* getPageFooterSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getPageFooterSplitType();
/**
* getColumnHeaderSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getColumnHeaderSplitType();
/**
* getColumnFooterSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getColumnFooterSplitType();
/**
* getGroupHeaderSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getGroupHeaderSplitType();
/**
* getGroupFooterSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getGroupFooterSplitType();
/**
* getDetailHeaderSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getDetailHeaderSplitType();
/**
* getDetailSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getDetailSplitType();
/**
* getDetailFooterSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getDetailFooterSplitType();
/**
* getLastPageFooterSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getLastPageFooterSplitType();
/**
* getSummarySplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getSummarySplitType();
/**
* getNoDataSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getNoDataSplitType();
/**
* getBackgroundSplitType.
*
* @return a {@link net.sf.dynamicreports.report.constant.SplitType} object.
*/
public SplitType getBackgroundSplitType();
/**
* getTitleStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getTitleStyle();
/**
* getPageHeaderStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getPageHeaderStyle();
/**
* getPageFooterStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getPageFooterStyle();
/**
* getColumnHeaderStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getColumnHeaderStyle();
/**
* getColumnFooterStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getColumnFooterStyle();
/**
* getGroupHeaderStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getGroupHeaderStyle();
/**
* getGroupFooterStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getGroupFooterStyle();
/**
* getDetailHeaderStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getDetailHeaderStyle();
/**
* getDetailStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getDetailStyle();
/**
* getDetailFooterStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getDetailFooterStyle();
/**
* getLastPageFooterStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getLastPageFooterStyle();
/**
* getSummaryStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getSummaryStyle();
/**
* getNoDataStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getNoDataStyle();
/**
* getBackgroundStyle.
*
* @return a {@link net.sf.dynamicreports.report.definition.style.DRIReportStyle} object.
*/
public DRIReportStyle getBackgroundStyle();
/**
* getTitleBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getTitleBackgroundComponent();
/**
* getPageHeaderBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getPageHeaderBackgroundComponent();
/**
* getPageFooterBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getPageFooterBackgroundComponent();
/**
* getColumnHeaderBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getColumnHeaderBackgroundComponent();
/**
* getColumnFooterBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getColumnFooterBackgroundComponent();
/**
* getGroupHeaderBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getGroupHeaderBackgroundComponent();
/**
* getGroupFooterBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getGroupFooterBackgroundComponent();
/**
* getDetailHeaderBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getDetailHeaderBackgroundComponent();
/**
* getDetailBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getDetailBackgroundComponent();
/**
* getDetailFooterBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getDetailFooterBackgroundComponent();
/**
* getLastPageFooterBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getLastPageFooterBackgroundComponent();
/**
* getSummaryBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getSummaryBackgroundComponent();
/**
* getNoDataBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getNoDataBackgroundComponent();
/**
* getBackgroundBackgroundComponent.
*
* @return a {@link net.sf.dynamicreports.report.definition.component.DRIComponent} object.
*/
public DRIComponent getBackgroundBackgroundComponent();
}