ASPdfExportParametersBean
Inheritance: java.lang.Object, BaseExportParameters
The PDF file format export parameters.
Constructors
| Constructor | Description |
|---|---|
| ASPdfExportParametersBean() | Instantiates a new Pdf export parameters. |
Methods
| Method | Description |
|---|---|
| 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 . |
| 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 . |
| getTextCompression() | Specifies compression type to be used for all content streams except images. Default is TextCompressionEnum.Flate . |
| setTextCompression(TextCompressionEnum textCompression) | Specifies compression type to be used for all content streams except images. Default is TextCompressionEnum.Flate . |
| getApplyImageTransparent() | Applies the specified transparent color to an image if true . |
| setApplyImageTransparent(boolean applyImageTransparent) | Applies the specified transparent color to an image if true . |
| getImageCompression() | Specifies compression type to be used for all images in the document. Default is ImageCompressionEnum.Auto . |
| setImageCompression(ImageCompressionEnum imageCompression) | Specifies compression type to be used for all images in the document. Default is ImageCompressionEnum.Auto . |
| getTabSize() | The tab-size property is used to customize the width of a tab (U+0009) character. Value: The size of the tab. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| getFontEmbeddingRuleEnum() | Gets or sets the font embedding rule. Value: The font embedding rule. |
| setFontEmbeddingRuleEnum(FontEmbeddingRuleEnum fontEmbeddingRuleEnum) | Gets or sets the font embedding rule. Value: The font embedding rule. |
| getRenderMetafileAsBitmap() | Gets or sets a value determining how metafile images should be rendered. |
| setRenderMetafileAsBitmap(Boolean renderMetafileAsBitmap) | Gets or sets a value determining how metafile images should be rendered. |
| 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. |
| 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. |
| getImageTransparentColor() | Gets or sets the image transparent color. Value: The color of the image transparent. |
| setImageTransparentColor(Color imageTransparentColor) | Gets or sets the image transparent color. Value: The color of the image transparent. |
| getEncryptionDetails() | Gets or sets a encryption details. If not set, then no encryption will be performed. |
| setEncryptionDetails(EncryptionDetails encryptionDetails) | Gets or sets a encryption details. If not set, then no encryption will be performed. |
| getKeywords() | Gets keywords of the document. |
| setKeywords(String value) | Sets keywords of the document. |
| getTitle() | Gets title of the document. |
| setTitle(String value) | Sets title of the document. |
| getAuthor() | Gets author of the document. |
| setAuthor(String value) | Sets author of the document. |
| getSubject() | Gets subject of the document. |
| setSubject(String value) | Gets or sets subject of the document. |
| getJpegQuality() | Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95. |
| setJpegQuality(int value) | Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95. |
| setPropertyValues(Object object) |
ASPdfExportParametersBean()
public ASPdfExportParametersBean()
Instantiates a new Pdf export parameters.
getPdfCompliance()
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 .
Returns: PdfComplianceEnum
setPdfCompliance(PdfComplianceEnum pdfCompliance)
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 .
getTextCompression()
public TextCompressionEnum getTextCompression()
Specifies compression type to be used for all content streams except images. Default is TextCompressionEnum.Flate .
Returns: TextCompressionEnum
setTextCompression(TextCompressionEnum textCompression)
public void setTextCompression(TextCompressionEnum textCompression)
Specifies compression type to be used for all content streams except images. Default is TextCompressionEnum.Flate .
getApplyImageTransparent()
public boolean getApplyImageTransparent()
Applies the specified transparent color to an image if true .
Returns: boolean
setApplyImageTransparent(boolean applyImageTransparent)
public void setApplyImageTransparent(boolean applyImageTransparent)
Applies the specified transparent color to an image if true .
getImageCompression()
public ImageCompressionEnum getImageCompression()
Specifies compression type to be used for all images in the document. Default is ImageCompressionEnum.Auto .
Returns: ImageCompressionEnum
setImageCompression(ImageCompressionEnum imageCompression)
public void setImageCompression(ImageCompressionEnum imageCompression)
Specifies compression type to be used for all images in the document. Default is ImageCompressionEnum.Auto .
getTabSize()
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.
Returns: long
setTabSize(long tabSize)
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.
getBookmarksOutlineLevel()
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.
Returns: int
setBookmarksOutlineLevel(int bookmarksOutlineLevel)
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.
getExpandedOutlineLevels()
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.
Returns: int
setExpandedOutlineLevels(int expandedOutlineLevels)
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.
getFontEmbeddingRuleEnum()
public FontEmbeddingRuleEnum getFontEmbeddingRuleEnum()
Gets or sets the font embedding rule. Value: The font embedding rule.
Returns: FontEmbeddingRuleEnum
setFontEmbeddingRuleEnum(FontEmbeddingRuleEnum fontEmbeddingRuleEnum)
public void setFontEmbeddingRuleEnum(FontEmbeddingRuleEnum fontEmbeddingRuleEnum)
Gets or sets the font embedding rule. Value: The font embedding rule.
getRenderMetafileAsBitmap()
public Boolean getRenderMetafileAsBitmap()
Gets or sets a value determining how metafile images should be rendered.
Returns: Boolean
setRenderMetafileAsBitmap(Boolean renderMetafileAsBitmap)
public void setRenderMetafileAsBitmap(Boolean renderMetafileAsBitmap)
Gets or sets a value determining how metafile images should be rendered.
getHeadingsOutlineLevels()
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.
Returns: int
setHeadingsOutlineLevels(int headingsOutlineLevels)
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.
getImageTransparentColor()
public Color getImageTransparentColor()
Gets or sets the image transparent color. Value: The color of the image transparent.
Returns: Color
setImageTransparentColor(Color imageTransparentColor)
public void setImageTransparentColor(Color imageTransparentColor)
Gets or sets the image transparent color. Value: The color of the image transparent.
getEncryptionDetails()
public EncryptionDetails getEncryptionDetails()
Gets or sets a encryption details. If not set, then no encryption will be performed.
Returns: EncryptionDetails
setEncryptionDetails(EncryptionDetails encryptionDetails)
public void setEncryptionDetails(EncryptionDetails encryptionDetails)
Gets or sets a encryption details. If not set, then no encryption will be performed.
getKeywords()
public String getKeywords()
Gets keywords of the document.
Returns: String - The keywords of the document.
setKeywords(String value)
public void setKeywords(String value)
Sets keywords of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | String | The keywords of the document. |
getTitle()
public String getTitle()
Gets title of the document.
Returns: String - The title of the document.
setTitle(String value)
public void setTitle(String value)
Sets title of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | String | The title of the document. |
getAuthor()
public String getAuthor()
Gets author of the document.
Returns: String - The author of the document.
setAuthor(String value)
public void setAuthor(String value)
Sets author of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | String | The author of the document. |
getSubject()
public String getSubject()
Gets subject of the document.
Returns: String - The subject of the document.
setSubject(String value)
public void setSubject(String value)
Gets or sets subject of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | String | The subject of the document. |
getJpegQuality()
public int getJpegQuality()
Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
Returns: int
setJpegQuality(int value)
public void setJpegQuality(int value)
Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
setPropertyValues(Object object)
public void setPropertyValues(Object object)