org.pushingpixels.substance.api.watermark

Class SubstanceCrosshatchWatermark

java.lang.Object

org.pushingpixels.substance.api.watermark.SubstanceCrosshatchWatermark

All Implemented Interfaces:

SubstanceTrait, SubstanceWatermark

public class SubstanceCrosshatchWatermark
extends java.lang.Object
implements SubstanceWatermark

Simple implementation of SubstanceWatermark, drawing cross hatches as watermark. This implementation is inspired by Office 12 background. This class is part of officially supported API.

Constructor Summary

Constructors

Constructor and Description
SubstanceCrosshatchWatermark()

Method Summary

Methods

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.
static java.lang.String	getName() Returns the name of all watermarks of this class.
void	previewWatermark(java.awt.Graphics g, SubstanceSkin skin, int x, int y, int width, int height) Draws the preview of the watermark image.
boolean	updateWatermarkImage(SubstanceSkin skin) Updates the current watermark image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubstanceCrosshatchWatermark

public SubstanceCrosshatchWatermark()

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(SubstanceSkin skin)

Description copied from interface: SubstanceWatermark

Updates the current watermark image.

Specified by:

updateWatermarkImage in interface SubstanceWatermark

Parameters:

skin - Skin for the watermark.

Returns:

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

previewWatermark

public void previewWatermark(java.awt.Graphics g,
                    SubstanceSkin skin,
                    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.

skin - Optional skin to use for the preview. Can be ignored by the implementation.

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.

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

Returns:

The display name of this trait.

getName

public static java.lang.String getName()

Returns the name of all watermarks of this class.

Returns:

The name of all watermarks of this class.

dispose

public void dispose()

Description copied from interface: SubstanceWatermark

Disposes the memory associated with this watermark.

Specified by:

dispose in interface SubstanceWatermark