Redactor.Appearance
extends Object| java.lang.Object | |
| ↳ | com.pdftron.pdf.Redactor.Appearance |
Class Overview
Class used to customize the appearance of the optional redaction overlay.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public boolean | border | Border specifies if the overlay will be surrounded by a border. | |||||||||
| public boolean | enableTextWrapping | Specifies whether text wrapping is enabled for overlay text. | |||||||||
| public Font | font | Specifies the font used to represent the text in the overlay. | |||||||||
| public int | horizTextAlignment | Specifies the horizontal text alignment in the overlay: align%lt;0 -> text will be left aligned. | |||||||||
| public double | maxFontSize | Specifies the maximum font size used to represent the text in the overlay. | |||||||||
| public double | minFontSize | Specifies the minimum font size used to represent the text in the overlay. | |||||||||
| public ColorPt | negativeOverlayColor | NegativeOverlayColor defines the overlay background color in RGB color space for negative redactions. | |||||||||
| public ColorPt | positiveOverlayColor | PositiveOverlayColor defines the overlay background color in RGB color space for positive redactions. | |||||||||
| public ColorPt | redactedContentColor | Specifies the color used to paint the regions where content was removed. | |||||||||
| public boolean | redactionOverlay | If RedactionOverlay is set to true, Redactor will draw an overlay covering all redacted regions. | |||||||||
| public boolean | showRedactedContentRegions | Specifies whether an overlay should be drawn in place of the redacted content. | |||||||||
| public ColorPt | textColor | Specifies the color used to paint the text in the overlay (in RGB). | |||||||||
| public boolean | useOverlayText | Specifies if the text (e.g. | |||||||||
| public int | vertTextAlignment | Specifies the vertical text alignment in the overlay: align<0 -> text will be bottom aligned. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Appearance() | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Fields
public boolean border
Border specifies if the overlay will be surrounded by a border.
public boolean enableTextWrapping
Specifies whether text wrapping is enabled for overlay text. When true, text is wrapped across multiple lines at MaxFontSize to fit within the redaction area. When false, text is rendered on a single line, scaled between MinFontSize and MaxFontSize as needed.
public int horizTextAlignment
Specifies the horizontal text alignment in the overlay: align%lt;0 -> text will be left aligned. align==0 -> text will be center aligned. align>0 -> text will be right aligned.
public double maxFontSize
Specifies the maximum font size used to represent the text in the overlay.
public double minFontSize
Specifies the minimum font size used to represent the text in the overlay.
public ColorPt negativeOverlayColor
NegativeOverlayColor defines the overlay background color in RGB color space for negative redactions.
public ColorPt positiveOverlayColor
PositiveOverlayColor defines the overlay background color in RGB color space for positive redactions.
public ColorPt redactedContentColor
Specifies the color used to paint the regions where content was removed. Default value is Gray color.
public boolean redactionOverlay
If RedactionOverlay is set to true, Redactor will draw an overlay covering all redacted regions. The rest of properties in the Appearance class defines visual properties of the overlay. If false the overlay region will not be drawn.
public boolean showRedactedContentRegions
Specifies whether an overlay should be drawn in place of the redacted content. This option can be used to indicate the areas where the content was removed from without revealing the content itself. Default value is False.
Note: The overlay region used redactedContentColor as a fill color.
public boolean useOverlayText
Specifies if the text (e.g. "Redacted" etc.) should be placed on top of the overlay. The remaining properties relate to the positioning, and styling of the overlay text.
public int vertTextAlignment
Specifies the vertical text alignment in the overlay: align<0 -> text will be bottom aligned. align==0 -> text will be center aligned. align>0 -> text will be top aligned.