com.groupdocs.redaction.redactions

Class ReplacementOptions

java.lang.Object

com.groupdocs.redaction.redactions.ReplacementOptions

public class ReplacementOptions
extends Object

Represents options for matched text replacement.

Learn more

• More details about document text redactions: Text redactions
• More details about redaction filters: Use PDF redaction filters

Constructor Summary

Constructors

Constructor and Description
ReplacementOptions(Color color) Initializes a new instance of ReplacementOptions class with colored rectangle as an option.
ReplacementOptions(String replacement) Initializes a new instance of ReplacementOptions class with replacement text as an option.

Method Summary

Modifier and Type	Method and Description
static ReplacementOptions	fromFilters(RedactionFilter[] filters)
ReplacementType	getActionType() Gets the replacement action: draw box or replace text.
Color	getBoxColor() Gets the color for a ReplacementType.DrawBox option (ignored otherwise).
RedactionFilter[]	getFilters() Gets an array of filters to apply with this redaction.
String	getReplacement() Gets the textual replacement value.
void	setBoxColor(Color value) Sets the color for a ReplacementType.DrawBox option (ignored otherwise).
void	setFilters(RedactionFilter[] value) Sets an array of filters to apply with this redaction.
void	setReplacement(String value) Sets the textual replacement value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplacementOptions

public ReplacementOptions(Color color)

Initializes a new instance of ReplacementOptions class with colored rectangle as an option.

Parameters:

color - Rectangle color

ReplacementOptions

public ReplacementOptions(String replacement)

Initializes a new instance of ReplacementOptions class with replacement text as an option.

Parameters:

replacement - Textual replacement

Method Detail

fromFilters

public static ReplacementOptions fromFilters(RedactionFilter[] filters)

getActionType

public final ReplacementType getActionType()

Gets the replacement action: draw box or replace text.

Returns:

The replacement action: draw box or replace text.

getBoxColor

public final Color getBoxColor()

Gets the color for a ReplacementType.DrawBox option (ignored otherwise).

Returns:

The color for a ReplacementType.DrawBox option (ignored otherwise).

getFilters

public final RedactionFilter[] getFilters()

Gets an array of filters to apply with this redaction.

Returns:

An array of filters to apply with this redaction.

getReplacement

public final String getReplacement()

Gets the textual replacement value.

Returns:

The textual replacement value.

setBoxColor

public final void setBoxColor(Color value)

Sets the color for a ReplacementType.DrawBox option (ignored otherwise).

Parameters:

value - The color for a ReplacementType.DrawBox option (ignored otherwise).

setFilters

public final void setFilters(RedactionFilter[] value)

Sets an array of filters to apply with this redaction.

Parameters:

value - An array of filters to apply with this redaction.

setReplacement

public final void setReplacement(String value)

Sets the textual replacement value.

Parameters:

value - The textual replacement value.