com.groupdocs.watermark.search

Class ColorRange

java.lang.Object

com.groupdocs.watermark.search.ColorRange

public class ColorRange
extends Object

Represents a range of colors. Specifies ranges using HSB representation of RGB color.

Constructor Summary

Constructors

Constructor and Description
ColorRange() Initializes a new instance of the ColorRange class.
ColorRange(Color exactColor) Initializes a new instance of the ColorRange class with a specified exact color.

Method Summary

Modifier and Type	Method and Description
float	getMaxBrightness() Gets the ending brightness value.
float	getMaxHue() Gets the ending hue value, in degrees.
float	getMaxSaturation() Gets the ending saturation value.
float	getMinBrightness() Gets the starting brightness value.
float	getMinHue() Gets the starting hue value, in degrees.
float	getMinSaturation() Gets the starting saturation value.
boolean	isEmpty() Gets a value indicating whether only the empty color is in range.
void	setEmpty(boolean value) Sets a value indicating whether only the empty color is in range.
void	setMaxBrightness(float value) Sets the ending brightness value.
void	setMaxHue(float value) Sets the ending hue value, in degrees.
void	setMaxSaturation(float value) Sets the ending saturation value.
void	setMinBrightness(float value) Sets the starting brightness value.
void	setMinHue(float value) Sets the starting hue value, in degrees.
void	setMinSaturation(float value) Sets the starting saturation value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorRange

public ColorRange()

Initializes a new instance of the ColorRange class.

ColorRange

public ColorRange(Color exactColor)

Initializes a new instance of the ColorRange class with a specified exact color.

Parameters:

exactColor - The exact color from which the range is created.

Method Detail

getMaxBrightness

public final float getMaxBrightness()

Gets the ending brightness value.

Returns:

The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

getMaxHue

public final float getMaxHue()

Gets the ending hue value, in degrees.

Returns:

The ending hue value, in degrees.

getMaxSaturation

public final float getMaxSaturation()

Gets the ending saturation value.

Returns:

The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

getMinBrightness

public final float getMinBrightness()

Gets the starting brightness value.

Returns:

The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

getMinHue

public final float getMinHue()

Gets the starting hue value, in degrees.

Returns:

The starting hue value, in degrees.

getMinSaturation

public final float getMinSaturation()

Gets the starting saturation value.

Returns:

The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

isEmpty

public final boolean isEmpty()

Gets a value indicating whether only the empty color is in range.

Returns:

True if only the empty color is in range (HSB ranges are ignored); otherwise, false.

setEmpty

public final void setEmpty(boolean value)

Sets a value indicating whether only the empty color is in range.

Parameters:

value - True if only the empty color is in range (HSB ranges are ignored); otherwise, false.

setMaxBrightness

public final void setMaxBrightness(float value)

Sets the ending brightness value.

Parameters:

value - The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

setMaxHue

public final void setMaxHue(float value)

Sets the ending hue value, in degrees.

Parameters:

value - The ending hue value, in degrees.

setMaxSaturation

public final void setMaxSaturation(float value)

Sets the ending saturation value.

Parameters:

value - The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.

setMinBrightness

public final void setMinBrightness(float value)

Sets the starting brightness value.

Parameters:

value - The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white.

setMinHue

public final void setMinHue(float value)

Sets the starting hue value, in degrees.

Parameters:

value - The starting hue value, in degrees.

setMinSaturation

public final void setMinSaturation(float value)

Sets the starting saturation value.

Parameters:

value - The saturation ranges from 0.0 through 1.0, where 0.0 is grayscale and 1.0 is the most saturated.