2
* Copyright (c) 2005-2010 Substance Kirill Grouchnikov. All Rights Reserved.
4
* Redistribution and use in source and binary forms, with or without
5
* modification, are permitted provided that the following conditions are met:
7
* o Redistributions of source code must retain the above copyright notice,
8
* this list of conditions and the following disclaimer.
10
* o Redistributions in binary form must reproduce the above copyright notice,
11
* this list of conditions and the following disclaimer in the documentation
12
* and/or other materials provided with the distribution.
14
* o Neither the name of Substance Kirill Grouchnikov nor the names of
15
* its contributors may be used to endorse or promote products derived
16
* from this software without specific prior written permission.
18
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
package org.pushingpixels.substance.api.watermark;
32
import java.awt.Component;
33
import java.awt.Graphics;
35
import org.pushingpixels.substance.api.SubstanceSkin;
36
import org.pushingpixels.substance.api.trait.SubstanceTrait;
39
* Interface for watermarks. This class is part of officially supported API.
41
* @author Kirill Grouchnikov
43
public interface SubstanceWatermark extends SubstanceTrait {
45
* Draws the watermark on the specified graphics context in the specified
51
* Component that is painted.
53
* Left X of the region.
55
* Top Y of the region.
61
public void drawWatermarkImage(Graphics graphics, Component c, int x,
62
int y, int width, int height);
65
* Updates the current watermark image.
68
* Skin for the watermark.
69
* @return <code>true</code> if the watermark has been updated successfully,
70
* <code>false</code> otherwise.
72
public boolean updateWatermarkImage(SubstanceSkin skin);
75
* Draws the preview of the watermark image.
80
* Optional skin to use for the preview. Can be ignored by the
83
* the <i>x</i> coordinate of the watermark to be drawn.
85
* The <i>y</i> coordinate of the watermark to be drawn.
87
* The width of the watermark to be drawn.
89
* The height of the watermark to be drawn.
91
public void previewWatermark(Graphics g, SubstanceSkin skin, int x, int y,
92
int width, int height);
95
* Disposes the memory associated with <code>this</code> watermark.
97
public void dispose();