Class SubstanceStripeWatermark
- java.lang.Object
-
- org.pushingpixels.substance.api.watermark.SubstanceStripeWatermark
-
- All Implemented Interfaces:
SubstanceTrait,SubstanceWatermark
public class SubstanceStripeWatermark extends Object implements SubstanceWatermark
Simple implementation ofSubstanceWatermark, drawing darker even lines as watermark. This is the default watermark implementation. This class is part of officially supported API.
-
-
Constructor Summary
Constructors Constructor Description SubstanceStripeWatermark()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddispose()Disposes the memory associated withthiswatermark.voiddrawWatermarkImage(Graphics graphics, Component c, int x, int y, int width, int height)Draws the watermark on the specified graphics context in the specified region.StringgetDisplayName()Returns the display name ofthistrait.voidpreviewWatermark(Graphics g, SubstanceSkin skin, int x, int y, int width, int height)Draws the preview of the watermark image.booleanupdateWatermarkImage(SubstanceSkin skin)Updates the current watermark image.
-
-
-
Method Detail
-
drawWatermarkImage
public void drawWatermarkImage(Graphics graphics, Component c, int x, int y, int width, int height)
Description copied from interface:SubstanceWatermarkDraws the watermark on the specified graphics context in the specified region.- Specified by:
drawWatermarkImagein interfaceSubstanceWatermark- 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:SubstanceWatermarkUpdates the current watermark image.- Specified by:
updateWatermarkImagein interfaceSubstanceWatermark- Parameters:
skin- Skin for the watermark.- Returns:
trueif the watermark has been updated successfully,falseotherwise.
-
previewWatermark
public void previewWatermark(Graphics g, SubstanceSkin skin, int x, int y, int width, int height)
Description copied from interface:SubstanceWatermarkDraws the preview of the watermark image.- Specified by:
previewWatermarkin interfaceSubstanceWatermark- 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 String getDisplayName()
Description copied from interface:SubstanceTraitReturns the display name ofthistrait. This method is part of officially supported API.- Specified by:
getDisplayNamein interfaceSubstanceTrait- Returns:
- The display name of
thistrait.
-
dispose
public void dispose()
Description copied from interface:SubstanceWatermarkDisposes the memory associated withthiswatermark.- Specified by:
disposein interfaceSubstanceWatermark
-
-