com.groupdocs.redaction.integration

Class RedactableImage

java.lang.Object

com.groupdocs.redaction.integration.RedactableImage

All Implemented Interfaces:

IImageFormatInstance, com.groupdocs.redaction.integration.IMultipleAreaRedactable

public class RedactableImage
extends Object
implements IImageFormatInstance, com.groupdocs.redaction.integration.IMultipleAreaRedactable

Provides facade to all raster image redaction operations.

Constructor Summary

Constructors

Constructor and Description
RedactableImage(IImageFormatInstance img) Creates a new instace using an object, implementing IImageFormatInstance interface.
RedactableImage(com.groupdocs.redaction.integration.IMultipleAreaRedactable img) Creates a new instace using an object, implementing IMultipleAreaRedactable interface.

Method Summary

Modifier and Type	Method and Description
RedactionResult	editArea(Point topLeft, RegionReplacementOptions options) Replaces the area at given point with a rectangle of specific color and size.
RedactionResult	editAreas(Rectangle[] rectangles, Color boxColor) Redacts multiple image areas at once with the same color.
InputStream	getRawStream() Retrieves a stream with actual image content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedactableImage

public RedactableImage(IImageFormatInstance img)

Creates a new instace using an object, implementing IImageFormatInstance interface.

Parameters:

img - An instance, implementing IImageFormatInstance interface

RedactableImage

public RedactableImage(com.groupdocs.redaction.integration.IMultipleAreaRedactable img)

Creates a new instace using an object, implementing IMultipleAreaRedactable interface.

Parameters:

img - An instance, implementing IMultipleAreaRedactable interface

Method Detail

editArea

public final RedactionResult editArea(Point topLeft,
                                      RegionReplacementOptions options)

Replaces the area at given point with a rectangle of specific color and size.

Specified by:

editArea in interface IImageFormatInstance

Parameters:

topLeft - Top-left corner coordinates of filled area

options - Color and size settings

Returns:

Image area redaction result

editAreas

public final RedactionResult editAreas(Rectangle[] rectangles,
                                       Color boxColor)

Redacts multiple image areas at once with the same color.

Specified by:

editAreas in interface com.groupdocs.redaction.integration.IMultipleAreaRedactable

Parameters:

rectangles - An array of rectangle areas

boxColor - Color to fill the areas

Returns:

Image areas redaction result

getRawStream

public final InputStream getRawStream()

Retrieves a stream with actual image content.

Specified by:

getRawStream in interface com.groupdocs.redaction.integration.IMultipleAreaRedactable

Returns:

Stream, containing image data