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.border;
31:
32: import java.awt.*;
33:
34: import org.jvnet.substance.color.ColorScheme;
35: import org.jvnet.substance.painter.SubstanceGradientPainter;
36: import org.jvnet.substance.utils.SubstanceTrait;
37:
38: /**
39: * Border painter interface for <b>Substance</b> look and feel. This class is
40: * part of officially supported API.<br>
41: * <br>
42: *
43: * Starting from version 4.0, the borders of some controls (buttons, check
44: * boxes, tabs, scroll bars etc) are painted by border painters. Up until
45: * version 4.0 this has been done by gradient painters ({@link SubstanceGradientPainter})
46: * instead. Note that a custom gradient painter may continue painting the
47: * borders, but these will be overriden by the current border painter. To allow
48: * easier migration, use {@link NullBorderPainter}.
49: *
50: * @author Kirill Grouchnikov
51: * @since version 4.0
52: */
53: public interface SubstanceBorderPainter extends SubstanceTrait {
54: /**
55: * Paints the control border.
56: *
57: * @param g
58: * Graphics.
59: * @param c
60: * Component.
61: * @param width
62: * Width of a UI component.
63: * @param height
64: * Height of a UI component.
65: * @param contour
66: * Contour of a UI component.
67: * @param innerContour
68: * Inner contour of a UI component. May be ignored if the
69: * specific implementation paints only the outside border.
70: * @param colorScheme1
71: * The first color scheme.
72: * @param colorScheme2
73: * The second color scheme.
74: * @param cyclePos
75: * Cycle position. Is used for rollover and pulsation effects.
76: * Must be in 0..10 range.
77: * @param useCyclePosAsInterpolation
78: * Indicates the algorithm to use for computing various colors.
79: * If <code>true</code>, the <code>cyclePos</code> is used
80: * to interpolate colors between different color components of
81: * both color schemes. If <code>false</code>, the
82: * <code>cyclePos</code> is used to interpolate colors between
83: * different color components of the first color scheme.
84: */
85: public void paintBorder(Graphics g, Component c, int width,
86: int height, Shape contour, Shape innerContour,
87: ColorScheme colorScheme1, ColorScheme colorScheme2,
88: float cyclePos, boolean useCyclePosAsInterpolation);
89: }
|