com.groupdocs.redaction.redactions

Class ImageAreaRedaction


  • public class ImageAreaRedaction
extends Redaction

    Represents a redaction that places colored rectangle in given area of an image document.

    <b>Learn more</b>

    • Constructor Detail

      • ImageAreaRedaction

        public ImageAreaRedaction(Point topLeft,
                  RegionReplacementOptions options)

        Initializes a new instance of ImageAreaRedaction class for redacting specific area size.

        Parameters:
        topLeft - Top-left area coordinates
        options - Area size and color

    • Method Detail

      • getOptions

        public final RegionReplacementOptions getOptions()

        Gets the RegionReplacementOptions options with color and area parameters.

        Returns:
        The RegionReplacementOptions options with color and area parameters.

      • getTopLeft

        public final Point getTopLeft()

        Gets the top-left position of the area to remove

        Returns:
        The top-left position of the area to remove

      • getDescription

        public String getDescription()

        Returns a string, describing the redaction and its parameters.

        Overrides:
        getDescription in class Redaction
        Returns:
        Text, containing redaction name and parameters.

      • applyTo

        public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)

        Applies the redaction to a given format instance.

        Specified by:
        applyTo in class Redaction
        Parameters:
        formatInstance - An instance of a document to apply redaction
        Returns:
        Status of the redaction: success/failure and error message if any