Package org.pushingpixels.substance.extras.api.watermarkpack

Class SubstanceNoiseWatermark

java.lang.Object

org.pushingpixels.substance.extras.api.watermarkpack.SubstanceNoiseWatermark

All Implemented Interfaces:

org.pushingpixels.substance.api.trait.SubstanceTrait, org.pushingpixels.substance.api.watermark.SubstanceWatermark

Direct Known Subclasses:

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

public class SubstanceNoiseWatermark
extends java.lang.Object
implements org.pushingpixels.substance.api.watermark.SubstanceWatermark

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

Field Summary

Fields

Modifier and Type	Field	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 Summary

Constructors

Constructor	Description
SubstanceNoiseWatermark(java.lang.String displayName, double xFactor, double yFactor, boolean hasConstantZ, NoiseFilter noiseFilter, boolean toBlur)	Creates a new noise-based watermark.

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	drawWatermarkImage(java.awt.Graphics graphics, java.awt.Component c, int x, int y, int width, int height)
java.lang.String	getDisplayName()
void	previewWatermark(java.awt.Graphics g, org.pushingpixels.substance.api.SubstanceSkin skin, int x, int y, int width, int height)
boolean	updateWatermarkImage(org.pushingpixels.substance.api.SubstanceSkin skin)

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)

Specified by:

drawWatermarkImage in interface org.pushingpixels.substance.api.watermark.SubstanceWatermark

updateWatermarkImage

public boolean updateWatermarkImage(org.pushingpixels.substance.api.SubstanceSkin skin)

Specified by:

updateWatermarkImage in interface org.pushingpixels.substance.api.watermark.SubstanceWatermark

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface org.pushingpixels.substance.api.trait.SubstanceTrait

previewWatermark

public void previewWatermark(java.awt.Graphics g,
                             org.pushingpixels.substance.api.SubstanceSkin skin,
                             int x,
                             int y,
                             int width,
                             int height)

Specified by:

previewWatermark in interface org.pushingpixels.substance.api.watermark.SubstanceWatermark

dispose

public void dispose()

Specified by:

dispose in interface org.pushingpixels.substance.api.watermark.SubstanceWatermark