public class ASPdfExportParametersBean extends BaseExportParameters
The PDF file format export parameters.
Constructor and Description |
---|
ASPdfExportParametersBean()
Instantiates a new Pdf export parameters.
|
Modifier and Type | Method and Description |
---|---|
boolean |
getApplyImageTransparent()
Applies the specified transparent color to an image if
true . |
String |
getAuthor()
Gets author of the document.
|
int |
getBookmarksOutlineLevel()
Specifies at which level in the document outline to display bookmark objects.
|
EncryptionDetails |
getEncryptionDetails()
Gets or sets a encryption details.
|
int |
getExpandedOutlineLevels()
Specifies how many levels in the document outline to show expanded when the PDF file is viewed.
|
FontEmbeddingRuleEnum |
getFontEmbeddingRuleEnum()
Gets or sets the font embedding rule.
|
int |
getHeadingsOutlineLevels()
Specifies how many levels of outline item to include in the document outline.
|
ImageCompressionEnum |
getImageCompression()
Specifies compression type to be used for all images in the document.
|
Color |
getImageTransparentColor()
Gets or sets the image transparent color.
|
int |
getJpegQuality()
Specifies the quality of JPEG compression for images (if JPEG compression is used).
|
String |
getKeywords()
Gets keywords of the document.
|
PdfComplianceEnum |
getPdfCompliance()
Desired conformance level for generated PDF document.
|
Boolean |
getRenderMetafileAsBitmap()
Gets or sets a value determining how metafile images should be rendered.
|
String |
getSubject()
Gets subject of the document.
|
long |
getTabSize()
The tab-size property is used to customize the width of a tab (U+0009) character.
|
TextCompressionEnum |
getTextCompression()
Specifies compression type to be used for all content streams except images.
|
String |
getTitle()
Gets title of the document.
|
void |
setApplyImageTransparent(boolean applyImageTransparent)
Applies the specified transparent color to an image if
true . |
void |
setAuthor(String value)
Sets author of the document.
|
void |
setBookmarksOutlineLevel(int bookmarksOutlineLevel)
Specifies at which level in the document outline to display bookmark objects.
|
void |
setEncryptionDetails(EncryptionDetails encryptionDetails)
Gets or sets a encryption details.
|
void |
setExpandedOutlineLevels(int expandedOutlineLevels)
Specifies how many levels in the document outline to show expanded when the PDF file is viewed.
|
void |
setFontEmbeddingRuleEnum(FontEmbeddingRuleEnum fontEmbeddingRuleEnum)
Gets or sets the font embedding rule.
|
void |
setHeadingsOutlineLevels(int headingsOutlineLevels)
Specifies how many levels of outline item to include in the document outline.
|
void |
setImageCompression(ImageCompressionEnum imageCompression)
Specifies compression type to be used for all images in the document.
|
void |
setImageTransparentColor(Color imageTransparentColor)
Gets or sets the image transparent color.
|
void |
setJpegQuality(int value)
Specifies the quality of JPEG compression for images (if JPEG compression is used).
|
void |
setKeywords(String value)
Sets keywords of the document.
|
void |
setPdfCompliance(PdfComplianceEnum pdfCompliance)
Desired conformance level for generated PDF document.
|
void |
setPropertyValues(Object object) |
void |
setRenderMetafileAsBitmap(Boolean renderMetafileAsBitmap)
Gets or sets a value determining how metafile images should be rendered.
|
void |
setSubject(String value)
Gets or sets subject of the document.
|
void |
setTabSize(long tabSize)
The tab-size property is used to customize the width of a tab (U+0009) character.
|
void |
setTextCompression(TextCompressionEnum textCompression)
Specifies compression type to be used for all content streams except images.
|
void |
setTitle(String value)
Sets title of the document.
|
getBackgroundColor, getLicense, isDrawBackground, setBackgroundColor, setDrawBackground, setLicense
public ASPdfExportParametersBean()
public PdfComplianceEnum getPdfCompliance()
Desired conformance level for generated PDF document.
Important note: This option should not be changed after PdfDocument object is constructed.
Default is PdfComplianceEnum.Pdf15
.
public void setPdfCompliance(PdfComplianceEnum pdfCompliance)
Desired conformance level for generated PDF document.
Important note: This option should not be changed after PdfDocument object is constructed.
Default is PdfComplianceEnum.Pdf15
.
public TextCompressionEnum getTextCompression()
Specifies compression type to be used for all content streams except images.
Default is TextCompressionEnum.Flate
.
public void setTextCompression(TextCompressionEnum textCompression)
Specifies compression type to be used for all content streams except images.
Default is TextCompressionEnum.Flate
.
public boolean getApplyImageTransparent()
Applies the specified transparent color to an image if true
.
public void setApplyImageTransparent(boolean applyImageTransparent)
Applies the specified transparent color to an image if true
.
public ImageCompressionEnum getImageCompression()
Specifies compression type to be used for all images in the document.
Default is ImageCompressionEnum.Auto
.
public void setImageCompression(ImageCompressionEnum imageCompression)
Specifies compression type to be used for all images in the document.
Default is ImageCompressionEnum.Auto
.
public long getTabSize()
The tab-size property is used to customize the width of a tab (U+0009) character.
Value: The size of the tab.public void setTabSize(long tabSize)
The tab-size property is used to customize the width of a tab (U+0009) character.
Value: The size of the tab.public int getBookmarksOutlineLevel()
Specifies at which level in the document outline to display bookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.
public void setBookmarksOutlineLevel(int bookmarksOutlineLevel)
Specifies at which level in the document outline to display bookmark objects. 0 - not displayed. 1 at first level and so on. Default is 0.
public int getExpandedOutlineLevels()
Specifies how many levels in the document outline to show expanded when the PDF file is viewed. 0 - the document outline is not expanded. 1 - first level items in the document are expanded and so on. Default is 0.
public void setExpandedOutlineLevels(int expandedOutlineLevels)
Specifies how many levels in the document outline to show expanded when the PDF file is viewed. 0 - the document outline is not expanded. 1 - first level items in the document are expanded and so on. Default is 0.
public FontEmbeddingRuleEnum getFontEmbeddingRuleEnum()
Gets or sets the font embedding rule.
Value: The font embedding rule.public void setFontEmbeddingRuleEnum(FontEmbeddingRuleEnum fontEmbeddingRuleEnum)
Gets or sets the font embedding rule.
Value: The font embedding rule.public Boolean getRenderMetafileAsBitmap()
Gets or sets a value determining how metafile images should be rendered.
public void setRenderMetafileAsBitmap(Boolean renderMetafileAsBitmap)
Gets or sets a value determining how metafile images should be rendered.
public int getHeadingsOutlineLevels()
Specifies how many levels of outline item to include in the document outline. 0 - no outline, 1 - one outline level and so on. Default is 0.
public void setHeadingsOutlineLevels(int headingsOutlineLevels)
Specifies how many levels of outline item to include in the document outline. 0 - no outline, 1 - one outline level and so on. Default is 0.
public Color getImageTransparentColor()
Gets or sets the image transparent color.
Value: The color of the image transparent.public void setImageTransparentColor(Color imageTransparentColor)
Gets or sets the image transparent color.
Value: The color of the image transparent.public EncryptionDetails getEncryptionDetails()
Gets or sets a encryption details. If not set, then no encryption will be performed.
public void setEncryptionDetails(EncryptionDetails encryptionDetails)
Gets or sets a encryption details. If not set, then no encryption will be performed.
public String getKeywords()
Gets keywords of the document.
public void setKeywords(String value)
Sets keywords of the document.
value
- The keywords of the document.public String getTitle()
Gets title of the document.
public void setTitle(String value)
Sets title of the document.
value
- The title of the document.public String getAuthor()
Gets author of the document.
public void setAuthor(String value)
Sets author of the document.
value
- The author of the document.public String getSubject()
Gets subject of the document.
public void setSubject(String value)
Gets or sets subject of the document.
value
- The subject of the document.public int getJpegQuality()
Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
public void setJpegQuality(int value)
Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
public void setPropertyValues(Object object)
setPropertyValues
in interface com.jaspersoft.jasperserver.api.engine.jasperreports.common.ExportParameters
setPropertyValues
in class BaseExportParameters