public class SubstanceNoiseWatermark extends java.lang.Object implements SubstanceWatermark
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
displayName
Display name of
this watermark. |
protected boolean |
hasConstantZ
Indicates whether
this watermark is based on constant Z
values. |
protected NoiseFilter |
noiseFilter
Noise filter of
this watermark. |
protected boolean |
toBlur
Indicates whether the resulting image (after applying the
noiseFilter ) should be blurred. |
protected double |
xFactor
Factor along X axis.
|
protected double |
yFactor
Factor along Y axis.
|
Constructor and Description |
---|
SubstanceNoiseWatermark(java.lang.String displayName,
double xFactor,
double yFactor,
boolean hasConstantZ,
NoiseFilter noiseFilter,
boolean toBlur)
Creates a new noise-based watermark.
|
Modifier and Type | Method and Description |
---|---|
void |
dispose()
Disposes the memory associated with
this watermark. |
void |
drawWatermarkImage(java.awt.Graphics graphics,
java.awt.Component c,
int x,
int y,
int width,
int height)
Draws the watermark on the specified graphics context in the specified
region.
|
java.lang.String |
getDisplayName()
Returns the display name of
this trait. |
void |
previewWatermark(java.awt.Graphics g,
int x,
int y,
int width,
int height)
Draws the preview of the watermark image.
|
boolean |
updateWatermarkImage(SubstanceSkin skin)
Updates the current watermark image.
|
protected java.lang.String displayName
this
watermark.protected double xFactor
protected double yFactor
protected boolean hasConstantZ
this
watermark is based on constant Z
values.protected NoiseFilter noiseFilter
this
watermark.protected boolean toBlur
noiseFilter
) should be blurred.public SubstanceNoiseWatermark(java.lang.String displayName, double xFactor, double yFactor, boolean hasConstantZ, NoiseFilter noiseFilter, boolean toBlur)
displayName
- Display name of this
watermark.xFactor
- Factor along X axis.yFactor
- Factor along Y axis.hasConstantZ
- Indicates whether this
watermark is based on
constant Z values.noiseFilter
- Noise filter of this
watermark.toBlur
- Indicates whether the resulting image should be blurred.public void drawWatermarkImage(java.awt.Graphics graphics, java.awt.Component c, int x, int y, int width, int height)
SubstanceWatermark
drawWatermarkImage
in interface SubstanceWatermark
graphics
- Graphics context.c
- Component that is painted.x
- Left X of the region.y
- Top Y of the region.width
- Region width.height
- Region height.public boolean updateWatermarkImage(SubstanceSkin skin)
SubstanceWatermark
updateWatermarkImage
in interface SubstanceWatermark
skin
- Skin for the watermark.true
if the watermark has been updated successfully,
false
otherwise.public java.lang.String getDisplayName()
SubstanceTrait
this
trait. This method is part
of officially supported API.getDisplayName
in interface SubstanceTrait
this
trait.public void previewWatermark(java.awt.Graphics g, int x, int y, int width, int height)
SubstanceWatermark
previewWatermark
in interface SubstanceWatermark
g
- Graphic context.x
- the x coordinate of the watermark to be drawn.y
- The y coordinate of the watermark to be drawn.width
- The width of the watermark to be drawn.height
- The height of the watermark to be drawn.public void dispose()
SubstanceWatermark
this
watermark.dispose
in interface SubstanceWatermark