001: /*
002: * Copyright (c) 2005-2008 Substance Kirill Grouchnikov. All Rights Reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of Substance Kirill Grouchnikov nor the names of
015: * its contributors may be used to endorse or promote products derived
016: * from this software without specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
020: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
021: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
022: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
023: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
025: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
026: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
027: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029: */
030: package org.jvnet.substance.watermark;
031:
032: import java.awt.Component;
033: import java.awt.Graphics;
034:
035: import org.jvnet.substance.utils.SubstanceTrait;
036:
037: /**
038: * Interface for watermarks. This class is part of officially supported API.
039: *
040: * @author Kirill Grouchnikov
041: */
042: public interface SubstanceWatermark extends SubstanceTrait {
043: /**
044: * Draws the watermark on the specified graphics context in the specified
045: * region.
046: *
047: * @param graphics
048: * Graphics context.
049: * @param c
050: * Component that is painted.
051: * @param x
052: * Left X of the region.
053: * @param y
054: * Top Y of the region.
055: * @param width
056: * Region width.
057: * @param height
058: * Region height.
059: */
060: public void drawWatermarkImage(Graphics graphics, Component c,
061: int x, int y, int width, int height);
062:
063: /**
064: * Updates the current watermark image.
065: *
066: * @return <code>true</code> if the watermark has been updated
067: * successfully, <code>false</code> otherwise.
068: */
069: public boolean updateWatermarkImage();
070:
071: /*
072: * (non-Javadoc)
073: *
074: * @see org.jvnet.substance.utils.SubstanceTrait#getDisplayName()
075: */
076: public String getDisplayName();
077:
078: /**
079: * Returns indication whether <code>this</code> watermark depends on the
080: * current {@link org.jvnet.substance.theme.SubstanceTheme}.
081: *
082: * @return <code>true</code> if <code>this</code> watermark depends on
083: * the current {@link org.jvnet.substance.theme.SubstanceTheme},
084: * <code>false</code> otherwise.
085: */
086: public boolean isDependingOnTheme();
087:
088: /**
089: * Draws the preview of the watermark image.
090: *
091: * @param g
092: * Graphic context.
093: * @param x
094: * the <i>x</i> coordinate of the watermark to be drawn.
095: * @param y
096: * The <i>y</i> coordinate of the watermark to be drawn.
097: * @param width
098: * The width of the watermark to be drawn.
099: * @param height
100: * The height of the watermark to be drawn.
101: */
102: public void previewWatermark(Graphics g, int x, int y, int width,
103: int height);
104:
105: /**
106: * Disposes the memory associated with <code>this</code> watermark.
107: */
108: public void dispose();
109: }
|