ImageAreaRedaction
Inheritance: java.lang.Object, com.groupdocs.redaction.Redaction
public class ImageAreaRedaction extends Redaction
Represents a redaction that places colored rectangle in given area of an image document.
Learn more
- More details about applying redactions: Redaction basics
- More details about image redactions: Image redactions
Constructors
| Constructor | Description |
|---|---|
| ImageAreaRedaction(Point topLeft, RegionReplacementOptions options) | Initializes a new instance of ImageAreaRedaction class for redacting specific area size. |
Methods
| Method | Description |
|---|---|
| getOptions() | Gets the RegionReplacementOptions options with color and area parameters. |
| getTopLeft() | Gets the top-left position of the area to remove |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
ImageAreaRedaction(Point topLeft, RegionReplacementOptions options)
public ImageAreaRedaction(Point topLeft, RegionReplacementOptions options)
Initializes a new instance of ImageAreaRedaction class for redacting specific area size.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| topLeft | java.awt.Point | Top-left area coordinates |
| options | RegionReplacementOptions | Area size and color |
getOptions()
public final RegionReplacementOptions getOptions()
Gets the RegionReplacementOptions options with color and area parameters.
Returns: RegionReplacementOptions - The RegionReplacementOptions options with color and area parameters.
getTopLeft()
public final Point getTopLeft()
Gets the top-left position of the area to remove
Returns: java.awt.Point - The top-left position of the area to remove
getDescription()
public String getDescription()
Returns a string, describing the redaction and its parameters.
Returns: java.lang.String - Text, containing redaction name and parameters.
applyTo(DocumentFormatInstance formatInstance)
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
Applies the redaction to a given format instance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |
Returns: RedactorLogEntry - Status of the redaction: success/failure and error message if any