net.sf.jasperreports.export.TextExporterConfiguration Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2018 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports 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.
*
* JasperReports 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 JasperReports. If not, see .
*/
package net.sf.jasperreports.export;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.export.JRTextExporter;
import net.sf.jasperreports.export.annotations.ExporterParameter;
import net.sf.jasperreports.export.annotations.ExporterProperty;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Interface containing settings used by the pure text exporter.
*
* @see JRTextExporter
*
* @author Teodor Danciu ([email protected])
*/
public interface TextExporterConfiguration extends ExporterConfiguration
{
/**
* Property whose value is used as default for the {@link #getPageSeparator()} export configuration setting.
* The default is the duplicated value of the "line.separator" system property.
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = "the duplicated value of the \"line.separator\" system property",
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_5_5_2
)
public static final String PROPERTY_PAGE_SEPARATOR = JRPropertiesUtil.PROPERTY_PREFIX + "export.text.page.separator";
/**
* Property whose value is used as default for the {@link #getLineSeparator()} export configuration setting.
* The default is the value of the "line.separator" system property.
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = "the value of the \"line.separator\" system property",
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_5_5_2
)
public static final String PROPERTY_LINE_SEPARATOR = JRPropertiesUtil.PROPERTY_PREFIX + "export.text.line.separator";
/**
* Property whose value is used as default for the {@link #isTrimLineRight()} export configuration setting.
*
* This property is by default not set (false
).
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_0_0,
valueType = Boolean.class
)
public static final String PROPERTY_TRIM_LINE_RIGHT = JRPropertiesUtil.PROPERTY_PREFIX + "export.text.trim.line.right";
/**
* Returns a string representing text that will be inserted between pages of the generated report. By default, JasperReports
* separates pages by two empty lines, but this behavior can be overridden by this parameter.
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRTextExporterParameter.class,
name="BETWEEN_PAGES_TEXT"
)
@ExporterProperty(PROPERTY_PAGE_SEPARATOR)
public String getPageSeparator();
/**
* Returns a string representing the separator between two lines of text. This parameter is useful since line separators can
* vary from one operating system to another. The default value is the system "line.separator" property.
*/
@SuppressWarnings("deprecation")
@ExporterParameter(
type=net.sf.jasperreports.engine.export.JRTextExporterParameter.class,
name="LINE_SEPARATOR"
)
@ExporterProperty(PROPERTY_LINE_SEPARATOR)
public String getLineSeparator();
/**
* Returns a boolean value specifying whether the lines of text in the document should be trimmed to the right.
* @see #PROPERTY_TRIM_LINE_RIGHT
*/
@ExporterProperty(
value=PROPERTY_TRIM_LINE_RIGHT,
booleanDefault=false
)
public Boolean isTrimLineRight();
}