@Deprecated public abstract class OfficeImageEffects extends Object
Represents effects that can be applied to an image watermark for an office document.
Modifier | Constructor and Description |
---|---|
protected |
OfficeImageEffects()
Deprecated.
Initializes a new instance of the
OfficeImageEffects class. |
Modifier and Type | Method and Description |
---|---|
OfficeLineFormat |
getBorderLineFormat()
Deprecated.
Gets a line format settings for the image border.
|
double |
getBrightness()
Deprecated.
Gets the brightness of the picture.
|
Color |
getChromaKey()
Deprecated.
Gets the color value of the image that will be treated as transparent.
|
double |
getContrast()
Deprecated.
Gets the contrast for the specified picture.
|
boolean |
getGrayScale()
Deprecated.
Gets a value indicating whether a picture will be displayed in grayscale mode.
|
void |
setBorderLineFormat(OfficeLineFormat value)
Deprecated.
Sets a line format settings for the image border.
|
void |
setBrightness(double value)
Deprecated.
Sets the brightness of the picture.
|
void |
setChromaKey(Color value)
Deprecated.
Sets the color value of the image that will be treated as transparent.
|
void |
setContrast(double value)
Deprecated.
Sets the contrast for the specified picture.
|
void |
setGrayScale(boolean value)
Deprecated.
Sets a value indicating whether a picture will be displayed in grayscale mode.
|
protected OfficeImageEffects()
Initializes a new instance of the OfficeImageEffects
class.
public final OfficeLineFormat getBorderLineFormat()
Gets a line format settings for the image border.
OfficeLineFormat
class, representing shape line format.public final void setBorderLineFormat(OfficeLineFormat value)
Sets a line format settings for the image border.
value
- Instance of OfficeLineFormat
class, representing shape line format.public final boolean getGrayScale()
Gets a value indicating whether a picture will be displayed in grayscale mode.
public final void setGrayScale(boolean value)
Sets a value indicating whether a picture will be displayed in grayscale mode.
value
- The default value is false.public final Color getChromaKey()
Gets the color value of the image that will be treated as transparent.
public final void setChromaKey(Color value)
Sets the color value of the image that will be treated as transparent.
value
- The default value is fully transparent color.public final double getBrightness()
Gets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
public final void setBrightness(double value)
Sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
value
- The default value is 0.5.public final double getContrast()
Gets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
public final void setContrast(double value)
Sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
value
- The default value is 0.5.