Package net.sf.jasperreports.export

Interface PptxExporterConfiguration

All Superinterfaces:

CommonExportConfiguration, ExporterConfiguration

All Known Implementing Classes:

SimplePptxExporterConfiguration

public interface PptxExporterConfiguration
extends ExporterConfiguration

Interface containing settings used by the PPTX exporter.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• JRPptxExporter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_BACKGROUND_AS_SLIDE_MASTER	Property that provides a default value for the isBackgroundAsSlideMaster() export configuration flag.
static final String	PROPERTY_EMBED_FONTS	Property that indicates if the fonts used in the report should be embedded into the generated PPTX document.
static final String	PROPERTY_ENCRYPTION_PASSWORD	Property whose value is used as default for the getEncryptionPassword() export configuration setting.
static final String	PROPERTY_METADATA_APPLICATION	Property whose value is used as default for the getMetadataApplication() export configuration setting.
static final String	PROPERTY_METADATA_AUTHOR	Property whose value is used as default for the getMetadataAuthor() export configuration setting.
static final String	PROPERTY_METADATA_KEYWORDS	Property whose value is used as default for the getMetadataKeywords() export configuration setting.
static final String	PROPERTY_METADATA_SUBJECT	Property whose value is used as default for the getMetadataSubject() export configuration setting.
static final String	PROPERTY_METADATA_TITLE	Property whose value is used as default for the getMetadataTitle() export configuration setting.
static final String	PROPERTY_SLIDE_MASTER_PAGE	Property that provides a default value for the getSlideMasterPage() export configuration setting.
static final String	PROPERTY_SLIDE_MASTER_REPORT	Property that provides a default value for the getSlideMasterReport() export configuration setting.

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Method Summary

Modifier and Type	Method	Description
String	getEncryptionPassword()	The encryption password needed to open the document, if it is encrypted.
String	getMetadataApplication()	The Application for the PPTX document.
String	getMetadataAuthor()	The Author of the PPTX document.
String	getMetadataKeywords()	The Keywords of the PPTX document.
String	getMetadataSubject()	The Subject of the PPTX document.
String	getMetadataTitle()	The Title of the PPTX document.
Integer	getSlideMasterPage()	Specifies the page from which the content of the slide master should be extracted.
Integer	getSlideMasterReport()	Specifies the report (export input item) from which the content of the slide master should be extracted.
Boolean	isBackgroundAsSlideMaster()	Flag that specifies whether the elements from the background section on the first page should be exported as the contents of the slide master, and then ignoring the background section elements for all pages/slides.
Boolean	isEmbedFonts()	Indicates whether the true type fonts used in the report should be embedded into the generated PPTX document.

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

isOverrideHints

Field Details

PROPERTY_METADATA_TITLE

static final String PROPERTY_METADATA_TITLE

Property whose value is used as default for the getMetadataTitle() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_AUTHOR

static final String PROPERTY_METADATA_AUTHOR

Property whose value is used as default for the getMetadataAuthor() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_SUBJECT

static final String PROPERTY_METADATA_SUBJECT

Property whose value is used as default for the getMetadataSubject() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_KEYWORDS

static final String PROPERTY_METADATA_KEYWORDS

Property whose value is used as default for the getMetadataKeywords() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_METADATA_APPLICATION

static final String PROPERTY_METADATA_APPLICATION

Property whose value is used as default for the getMetadataApplication() export configuration setting.

See Also:

• Constant Field Values

PROPERTY_SLIDE_MASTER_REPORT

static final String PROPERTY_SLIDE_MASTER_REPORT

Property that provides a default value for the getSlideMasterReport() export configuration setting.

Default value is 1.

Since:

6.8.0

See Also:

• JRPropertiesUtil
• Constant Field Values

PROPERTY_SLIDE_MASTER_PAGE

static final String PROPERTY_SLIDE_MASTER_PAGE

Property that provides a default value for the getSlideMasterPage() export configuration setting.

Default value is 1.

Since:

6.8.0

See Also:

• JRPropertiesUtil
• Constant Field Values

PROPERTY_BACKGROUND_AS_SLIDE_MASTER

static final String PROPERTY_BACKGROUND_AS_SLIDE_MASTER

Property that provides a default value for the isBackgroundAsSlideMaster() export configuration flag.

Default value is false.

Since:

6.8.0

See Also:

• JRPropertiesUtil
• Constant Field Values

PROPERTY_EMBED_FONTS

static final String PROPERTY_EMBED_FONTS

Property that indicates if the fonts used in the report should be embedded into the generated PPTX document.

Note: PowerPoint does not embed TTF content type. Only EOT (Embedded OpenType) fonts are considered for embedding. Embeddable TTF fonts should be converted into EOT format first, then placed in the classpath using the font extension mechanism.

This property serves as default value for the isEmbedFonts() export configuration setting.

See Also:

• JRPropertiesUtil
• Constant Field Values

PROPERTY_ENCRYPTION_PASSWORD

static final String PROPERTY_ENCRYPTION_PASSWORD

Property whose value is used as default for the getEncryptionPassword() export configuration setting.

See Also:

• JRPropertiesUtil
• Constant Field Values

Method Details

getMetadataTitle

String getMetadataTitle()

The Title of the PPTX document.

getMetadataAuthor

String getMetadataAuthor()

The Author of the PPTX document.

getMetadataSubject

String getMetadataSubject()

The Subject of the PPTX document.

getMetadataKeywords

String getMetadataKeywords()

The Keywords of the PPTX document.

getMetadataApplication

String getMetadataApplication()

The Application for the PPTX document. Defaults to "JasperReports Library version x.x.x".

isBackgroundAsSlideMaster

Boolean isBackgroundAsSlideMaster()

Flag that specifies whether the elements from the background section on the first page should be exported as the contents of the slide master, and then ignoring the background section elements for all pages/slides.

See Also:

• PROPERTY_BACKGROUND_AS_SLIDE_MASTER

getSlideMasterReport

Integer getSlideMasterReport()

Specifies the report (export input item) from which the content of the slide master should be extracted. The default value is 1 (first report).

See Also:

• PROPERTY_SLIDE_MASTER_REPORT

getSlideMasterPage

Integer getSlideMasterPage()

Specifies the page from which the content of the slide master should be extracted. The default value is 1 (first page).

See Also:

• PROPERTY_SLIDE_MASTER_PAGE

isEmbedFonts

Boolean isEmbedFonts()

Indicates whether the true type fonts used in the report should be embedded into the generated PPTX document.

See Also:

• PROPERTY_EMBED_FONTS

getEncryptionPassword

String getEncryptionPassword()

The encryption password needed to open the document, if it is encrypted.

See Also:

• PROPERTY_ENCRYPTION_PASSWORD