|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jvnet.substance.watermark.SubstanceNoiseWatermark
public class SubstanceNoiseWatermark
Base class for noise-based watermarks. This class is part of officially supported API.
Field Summary | |
---|---|
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 Summary | |
---|---|
SubstanceNoiseWatermark(java.lang.String displayName,
double xFactor,
double yFactor,
boolean hasConstantZ,
NoiseFilter noiseFilter,
boolean toBlur)
Creates a new noise-based watermark. |
Method Summary | |
---|---|
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. |
boolean |
isDependingOnTheme()
Returns indication whether this watermark depends on the
current SubstanceTheme . |
void |
previewWatermark(java.awt.Graphics g,
int x,
int y,
int width,
int height)
Draws the preview of the watermark image. |
boolean |
updateWatermarkImage()
Updates the current watermark image. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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.
Constructor Detail |
---|
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.Method Detail |
---|
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()
SubstanceWatermark
updateWatermarkImage
in interface SubstanceWatermark
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
getDisplayName
in interface SubstanceWatermark
this
trait.public boolean isDependingOnTheme()
SubstanceWatermark
this
watermark depends on the
current SubstanceTheme
.
isDependingOnTheme
in interface SubstanceWatermark
true
if this
watermark depends on
the current SubstanceTheme
,
false
otherwise.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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |