com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class RedactionAnnotation

  • All Implemented Interfaces:
    com.aspose.ms.System.ICloneable


    public final class RedactionAnnotation
    extends Annotation

    Represents Redact annotation.

    • Constructor Detail

      • RedactionAnnotation

        public RedactionAnnotation(IDocument document)

        Constructor for RedactionAnnotation. For using in Generator.

        Parameters:
        document - Document where new annotation will be created.
      • RedactionAnnotation

        public RedactionAnnotation(Page page,
                                   Rectangle rect)

        Constructor for RedactAnnotation.

        Parameters:
        page - Page where annotation will be placed.
        rect - Annotation position on the page.
    • Method Detail

      • accept

        public void accept(AnnotationSelector visitor)

        Accepts visitor object to process the annotation.

        Specified by:
        accept in class Annotation
        Parameters:
        visitor - Visitor object.
      • getQuadPoint

        public Point[] getQuadPoint()

        An array of 8xN numbers specifying the coordinates of content region that is intended to be removed.

        Returns:
        array of point
      • setQuadPoint

        public void setQuadPoint(Point[] value)

        An array of 8xN numbers specifying the coordinates of content region that is intended to be removed.

        Parameters:
        value - array of point
      • getFillColor

        public Color getFillColor()

        Gets color to fill annotation.

        Returns:
        color value
      • setFillColor

        public void setFillColor(Color value)

        Sets color to fill annotation.

        Parameters:
        value - color value
      • getBorderColor

        public Color getBorderColor()

        Gets color of border which is drawn when redaction is not active.

        Returns:
        Color value
      • setBorderColor

        public void setBorderColor(Color value)

        Sets color of border which is drawn when redaction is not active.

        Parameters:
        value - Color value
      • getOverlayText

        public String getOverlayText()

        Text to print on redact annotation.

        Returns:
        string value
      • setOverlayText

        public void setOverlayText(String value)

        Text to print on redact annotation.

        Parameters:
        value - string object
      • isRepeat

        public boolean isRepeat()

        If true overlay text will be repated on the annotation.

        Returns:
        boolean value
      • setRepeat

        public void setRepeat(boolean value)

        If true overlay text will be repated on the annotation.

        Parameters:
        value - boolean value
      • getTextAlignment

        public int getTextAlignment()

        Gets alignment of Overlay Text.

        Returns:
        HorizontalAlignment value
        See Also:
        HorizontalAlignment
      • setTextAlignment

        public void setTextAlignment(int value)

        Sets alignment of Overlay Text.

        Parameters:
        value - HorizontalAlignment value
        See Also:
        HorizontalAlignment
      • flatten

        public void flatten()

        Flattens annotation i.e. removes annotation and adds its content

        Overrides:
        flatten in class Annotation
      • redact

        public void redact()

        Flattens annotation and redacts page contents (i.e. removes text and image content under redacted annotation)

      • redactExact

        public void redactExact()

        Flattens annotation and redacts page contents (i.e. removes text and image content exactly under redacted annotation)

      • getAnnotationType

        public int getAnnotationType()

        Gets type of annotation.

        Specified by:
        getAnnotationType in class Annotation
        Returns:
        AnnotationType element
        See Also:
        AnnotationType
      • setFontSize

        public void setFontSize(int fontSize)

        Font size of text to print on redact annotation.

        Default value is 10.
        Parameters:
        fontSize - int value