PdfRenderingOptions (Aspose.HTML for Java (21.12) API Documentation)

java.lang.Object
- com.aspose.html.rendering.RenderingOptions
- - com.aspose.html.rendering.pdf.PdfRenderingOptions

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

PdfSaveOptions
```
public class PdfRenderingOptions
extends RenderingOptions
```
Represents rendering options for PdfDevice.

Constructor Summary

Constructors
Constructor and Description

PdfRenderingOptions()

Constructors
Constructor and Description
`PdfRenderingOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getApplyImageTransparent()` Applies the specified transparent color to an image if `true`.
`int`	`getCompliance()` Desired conformance level for generated PDF document.
`com.aspose.html.rendering.pdf.PdfComplianceOptions`	`getComplianceOptions()` Represents Pdf compliance options.
`com.aspose.html.rendering.pdf.signature.PdfDigitalSignatureDetailsCore`	`getDigitalSignatureDetails()` Gets or sets a digital signature details.
`PdfEncryptionInfo`	`getEncryption()` 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. 0 - the document outline is not expanded. 1 - first level items in the document are expanded and so on.
`int`	`getFontEmbeddingRule()` Gets or sets the font embedding rule.
`com.aspose.html.rendering.pdf.FontExceptionCollection`	`getFontException()` Gets the font embedding exception.
`int`	`getImageCompression()` Specifies compression type to be used for all images in the document.
`com.aspose.ms.System.Drawing.Color`	`getImageTransparentColor()` Gets or sets the image transparent color.
`int`	`getJpegQuality()` Specifies the quality of JPEG compression for images (if JPEG compression is used).
`boolean`	`getPdfaCompliant()` Gets a value indicating whether [pdfa compliant].
`long`	`getTabSize()` The tab-size property is used to customize the width of a tab (U+0009) character.
`int`	`getTextCompression()` Specifies compression type to be used for all content streams except images.
`boolean`	`isEncrypted()` Returns true if document encryption option is on.
`boolean`	`isShowHyperlinkRects()` A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.
`void`	`setApplyImageTransparent(boolean value)` Applies the specified transparent color to an image if `true`.
`void`	`setCompliance(int value)` Desired conformance level for generated PDF document.
`void`	`setComplianceOptions(com.aspose.html.rendering.pdf.PdfComplianceOptions value)` Represents Pdf compliance options.
`void`	`setDigitalSignatureDetails(com.aspose.html.rendering.pdf.signature.PdfDigitalSignatureDetailsCore value)` Gets or sets a digital signature details.
`void`	`setEncryption(PdfEncryptionInfo value)` Gets or sets a encryption details.
`void`	`setExpandedOutlineLevels(int value)` 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.
`void`	`setFontEmbeddingRule(int value)` Gets or sets the font embedding rule.
`void`	`setImageCompression(int value)` Specifies compression type to be used for all images in the document.
`void`	`setImageTransparentColor(com.aspose.ms.System.Drawing.Color value)` 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`	`setShowHyperlinkRects(boolean value)` A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.
`void`	`setTabSize(long value)` The tab-size property is used to customize the width of a tab (U+0009) character.
`void`	`setTextCompression(int value)` Specifies compression type to be used for all content streams except images.
`void`	`validate()` Validates that the requested options are compatible with each other and throws an exception with an explanatory message if needed.

Methods inherited from class com.aspose.html.rendering.RenderingOptions
deepClone, getBackgroundColor, getCss, getHorizontalResolution, getPageSetup, getVerticalResolution, memberwiseClone, setBackgroundColor, setHorizontalResolution, setPageSetup, setVerticalResolution

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PdfRenderingOptions
```
public PdfRenderingOptions()
```
- Method Detail
  - validate
```
public void validate()
```
    Validates that the requested options are compatible with each other and throws an exception with an explanatory message if needed.
  - 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.
  - setExpandedOutlineLevels
```
public void setExpandedOutlineLevels(int value)
```
    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.
  - getTextCompression
```
public int getTextCompression()
```
    Specifies compression type to be used for all content streams except images. Default is PdfTextCompressionCore.Flate.
  - setTextCompression
```
public void setTextCompression(int value)
```
    Specifies compression type to be used for all content streams except images. Default is PdfTextCompressionCore.Flate.
  - getImageCompression
```
public int getImageCompression()
```
    Specifies compression type to be used for all images in the document. Default is PdfImageCompression.Auto.
  - setImageCompression
```
public void setImageCompression(int value)
```
    Specifies compression type to be used for all images in the document. Default is PdfImageCompression.Auto.
  - getJpegQuality
```
public int getJpegQuality()
```
    Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
  - setJpegQuality
```
public void setJpegQuality(int value)
```
    Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
  - isShowHyperlinkRects
```
public boolean isShowHyperlinkRects()
```
    A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.
  - setShowHyperlinkRects
```
public void setShowHyperlinkRects(boolean value)
```
    A debug settings that turns on display of active rectangles of hyperlinks in the PDF document.
  - getCompliance
```
public int getCompliance()
```
    Desired conformance level for generated PDF document. Important note: This option should not be changed after PdfDocument object is constructed. Default is PdfComplianceCore.Pdf15.
  - setCompliance
```
public void setCompliance(int value)
```
    Desired conformance level for generated PDF document. Important note: This option should not be changed after PdfDocument object is constructed. Default is PdfComplianceCore.Pdf15.
  - getComplianceOptions
```
public com.aspose.html.rendering.pdf.PdfComplianceOptions getComplianceOptions()
```
    Represents Pdf compliance options.
  - setComplianceOptions
```
public void setComplianceOptions(com.aspose.html.rendering.pdf.PdfComplianceOptions value)
```
    Represents Pdf compliance options.
  - getPdfaCompliant
```
public boolean getPdfaCompliant()
```
    Gets a value indicating whether [pdfa compliant].
    Value: true if [pdfa compliant]; otherwise, false.
  - getEncryption
```
public PdfEncryptionInfo getEncryption()
```
    Gets or sets a encryption details. If not set, then no encryption will be performed.
  - setEncryption
```
public void setEncryption(PdfEncryptionInfo value)
```
    Gets or sets a encryption details. If not set, then no encryption will be performed.
  - isEncrypted
```
public boolean isEncrypted()
```
    Returns true if document encryption option is on.
  - getImageTransparentColor
```
public com.aspose.ms.System.Drawing.Color getImageTransparentColor()
```
    Gets or sets the image transparent color.
    Value: The color of the image transparent.
  - setImageTransparentColor
```
public void setImageTransparentColor(com.aspose.ms.System.Drawing.Color value)
```
    Gets or sets the image transparent color.
    Value: The color of the image transparent.
  - getApplyImageTransparent
```
public boolean getApplyImageTransparent()
```
    Applies the specified transparent color to an image if true.
  - setApplyImageTransparent
```
public void setApplyImageTransparent(boolean value)
```
    Applies the specified transparent color to an image if true.
  - getDigitalSignatureDetails
```
public com.aspose.html.rendering.pdf.signature.PdfDigitalSignatureDetailsCore getDigitalSignatureDetails()
```
    Gets or sets a digital signature details. If not set, then no signing will be performed.
  - setDigitalSignatureDetails
```
public void setDigitalSignatureDetails(com.aspose.html.rendering.pdf.signature.PdfDigitalSignatureDetailsCore value)
```
    Gets or sets a digital signature details. If not set, then no signing will be performed.
  - getFontException
```
public com.aspose.html.rendering.pdf.FontExceptionCollection getFontException()
```
    Gets the font embedding exception.
  - getFontEmbeddingRule
```
public int getFontEmbeddingRule()
```
    Gets or sets the font embedding rule.
    Value: The font embedding rule.
  - setFontEmbeddingRule
```
public void setFontEmbeddingRule(int value)
```
    Gets or sets the font embedding rule.
    Value: The font embedding rule.
  - 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.
  - setTabSize
```
public void setTabSize(long value)
```
    The tab-size property is used to customize the width of a tab (U+0009) character.
    Value: The size of the tab.

Class PdfRenderingOptions

Constructor Summary

Method Summary

Methods inherited from class com.aspose.html.rendering.RenderingOptions

Methods inherited from class java.lang.Object

Constructor Detail

PdfRenderingOptions

Method Detail

validate

getExpandedOutlineLevels

setExpandedOutlineLevels

getTextCompression

setTextCompression

getImageCompression

setImageCompression

getJpegQuality

setJpegQuality

isShowHyperlinkRects

setShowHyperlinkRects

getCompliance

setCompliance

getComplianceOptions

setComplianceOptions

getPdfaCompliant

getEncryption

setEncryption

isEncrypted

getImageTransparentColor

setImageTransparentColor

getApplyImageTransparent

setApplyImageTransparent

getDigitalSignatureDetails

setDigitalSignatureDetails

getFontException

getFontEmbeddingRule

setFontEmbeddingRule

getTabSize

setTabSize