01: /*
02: * Copyright (c) 2005-2008 Substance Kirill Grouchnikov. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
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.
13: *
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.
17: *
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.
29: */
30: package org.jvnet.substance.painter.highlight;
31:
32: import java.awt.Component;
33: import java.awt.Graphics2D;
34: import java.util.Set;
35:
36: import org.jvnet.substance.color.ColorScheme;
37: import org.jvnet.substance.utils.SubstanceTrait;
38: import org.jvnet.substance.utils.SubstanceConstants.Side;
39:
40: /**
41: * Highlight painter interface for <b>Substance</b> look and feel. This class
42: * is part of officially supported API.<br>
43: * <br>
44: *
45: * @author Kirill Grouchnikov
46: * @since version 4.3
47: */
48: public interface SubstanceHighlightPainter extends SubstanceTrait {
49: /**
50: * Paints the highlight.
51: *
52: * @param graphics
53: * Graphics context.
54: * @param comp
55: * Component.
56: * @param width
57: * Width.
58: * @param height
59: * Height.
60: * @param borderAlpha
61: * Border alpha factor.
62: * @param openSides
63: * The sides specified in this set will not be painted. Can be
64: * <code>null</code> or empty.
65: * @param colorScheme1
66: * The first color scheme.
67: * @param colorScheme2
68: * The second color scheme.
69: * @param cyclePos
70: * Cycle position. Is used for rollover and selection animations.
71: * Must be in 0..10 range.
72: */
73: public void paintHighlight(Graphics2D graphics, Component comp,
74: int width, int height, float borderAlpha,
75: Set<Side> openSides, ColorScheme colorScheme1,
76: ColorScheme colorScheme2, float cyclePos);
77: }
|