net.sf.jasperreports.export.DocxExporterConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, 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.ooxml.JRDocxExporter;
import net.sf.jasperreports.export.annotations.ExporterProperty;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Interface containing settings used by the DOCX exporter.
*
* @see JRDocxExporter
*
* @author Teodor Danciu ([email protected])
*/
public interface DocxExporterConfiguration extends ExporterConfiguration
{
/**
* Property whose value is used as default for the {@link #getMetadataTitle()} export configuration setting.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_3_1
)
public static final String PROPERTY_METADATA_TITLE = JRDocxExporter.DOCX_EXPORTER_PROPERTIES_PREFIX + "metadata.title";
/**
* Property whose value is used as default for the {@link #getMetadataAuthor()} export configuration setting.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_3_1
)
public static final String PROPERTY_METADATA_AUTHOR = JRDocxExporter.DOCX_EXPORTER_PROPERTIES_PREFIX + "metadata.author";
/**
* Property whose value is used as default for the {@link #getMetadataSubject()} export configuration setting.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_3_1
)
public static final String PROPERTY_METADATA_SUBJECT = JRDocxExporter.DOCX_EXPORTER_PROPERTIES_PREFIX + "metadata.subject";
/**
* Property whose value is used as default for the {@link #getMetadataKeywords()} export configuration setting.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_3_1
)
public static final String PROPERTY_METADATA_KEYWORDS = JRDocxExporter.DOCX_EXPORTER_PROPERTIES_PREFIX + "metadata.keywords";
/**
* Property whose value is used as default for the {@link #getMetadataApplication()} export configuration setting.
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_3_1
)
public static final String PROPERTY_METADATA_APPLICATION = JRDocxExporter.DOCX_EXPORTER_PROPERTIES_PREFIX + "metadata.application";
/**
* Property that indicates whether the true type fonts used in the report should be embedded into the generated DOCX document.
* This property serves as default value for the {@link #isEmbedFonts()} export configuration setting.
*/
@Property(
name = "net.sf.jasperreports.export.docx.embed.fonts",
defaultValue = PropertyConstants.BOOLEAN_FALSE,
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_9_0,
valueType = Boolean.class
)
public static final String PROPERTY_EMBED_FONTS = JRDocxExporter.DOCX_EXPORTER_PROPERTIES_PREFIX + "embed.fonts";
/**
* Property whose value is used as default for the {@link #getEncryptionPassword()} export configuration setting.
*
* @see JRPropertiesUtil
*/
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
scopes = {PropertyScope.CONTEXT, PropertyScope.REPORT},
sinceVersion = PropertyConstants.VERSION_6_20_1
)
public static final String PROPERTY_ENCRYPTION_PASSWORD = JRPropertiesUtil.PROPERTY_PREFIX + "export.docx.encryption.password";
/**
* The Title of the DOCX document.
*/
@ExporterProperty(PROPERTY_METADATA_TITLE)
public String getMetadataTitle();
/**
* The Author of the DOCX document.
*/
@ExporterProperty(PROPERTY_METADATA_AUTHOR)
public String getMetadataAuthor();
/**
* The Subject of the DOCX document.
*/
@ExporterProperty(PROPERTY_METADATA_SUBJECT)
public String getMetadataSubject();
/**
* The Keywords of the DOCX document.
*/
@ExporterProperty(PROPERTY_METADATA_KEYWORDS)
public String getMetadataKeywords();
/**
* The Application for the DOCX document. Defaults to "JasperReports Library version x.x.x".
*/
@ExporterProperty(PROPERTY_METADATA_APPLICATION)
public String getMetadataApplication();
/**
* Indicates whether the true type fonts used in the report should be embedded into the generated DOCX document.
* @see #PROPERTY_EMBED_FONTS
*/
@ExporterProperty(
value=PROPERTY_EMBED_FONTS,
booleanDefault=false
)
public Boolean isEmbedFonts();
/**
* The encryption password needed to open the document, if it is encrypted.
* @see #PROPERTY_ENCRYPTION_PASSWORD
*/
@ExporterProperty(PROPERTY_ENCRYPTION_PASSWORD)
public String getEncryptionPassword();
}