org.jvnet.substance.watermark
Class SubstanceNoiseWatermark

java.lang.Object
  org.jvnet.substance.watermark.SubstanceNoiseWatermark

All Implemented Interfaces:

SubstanceTrait, SubstanceWatermark

Direct Known Subclasses:

SubstanceCopperplateEngravingWatermark, SubstanceFabricWatermark, SubstanceGenericNoiseWatermark, SubstanceMagneticFieldWatermark, SubstanceMarbleVeinWatermark, SubstanceMazeWatermark, SubstancePlanktonWatermark, SubstanceWoodWatermark

public class SubstanceNoiseWatermark
extends java.lang.Object
implements SubstanceWatermark

Base class for noise-based watermarks. This class is part of officially supported API.

Author:

Kirill Grouchnikov

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

displayName

protected java.lang.String displayName

Display name of this watermark.

xFactor

protected double xFactor

Factor along X axis.

yFactor

protected double yFactor

Factor along Y axis.

hasConstantZ

protected boolean hasConstantZ

Indicates whether this watermark is based on constant Z values.

noiseFilter

protected NoiseFilter noiseFilter

Noise filter of this watermark.

toBlur

protected boolean toBlur

Indicates whether the resulting image (after applying the noiseFilter) should be blurred.

Constructor Detail

SubstanceNoiseWatermark

public SubstanceNoiseWatermark(java.lang.String displayName,
                               double xFactor,
                               double yFactor,
                               boolean hasConstantZ,
                               NoiseFilter noiseFilter,
                               boolean toBlur)

Creates a new noise-based watermark.

Parameters:

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

drawWatermarkImage

public void drawWatermarkImage(java.awt.Graphics graphics,
                               java.awt.Component c,
                               int x,
                               int y,
                               int width,
                               int height)

Description copied from interface: SubstanceWatermark

Draws the watermark on the specified graphics context in the specified region.

Specified by:

drawWatermarkImage in interface SubstanceWatermark

Parameters:

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.

updateWatermarkImage

public boolean updateWatermarkImage()

Description copied from interface: SubstanceWatermark

Updates the current watermark image.

Specified by:

updateWatermarkImage in interface SubstanceWatermark

Returns:

true if the watermark has been updated successfully, false otherwise.

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: SubstanceTrait

Returns the display name of this trait. This method is part of officially supported API.

Specified by:

getDisplayName in interface SubstanceTrait

Specified by:

getDisplayName in interface SubstanceWatermark

Returns:

The display name of this trait.

isDependingOnTheme

public boolean isDependingOnTheme()

Description copied from interface: SubstanceWatermark

Returns indication whether this watermark depends on the current SubstanceTheme.

Specified by:

isDependingOnTheme in interface SubstanceWatermark

Returns:

true if this watermark depends on the current SubstanceTheme, false otherwise.

previewWatermark

public void previewWatermark(java.awt.Graphics g,
                             int x,
                             int y,
                             int width,
                             int height)

Description copied from interface: SubstanceWatermark

Draws the preview of the watermark image.

Specified by:

previewWatermark in interface SubstanceWatermark

Parameters:

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.

dispose

public void dispose()

Description copied from interface: SubstanceWatermark

Disposes the memory associated with this watermark.

Specified by:

dispose in interface SubstanceWatermark