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.grip;
31:
32: import java.awt.*;
33:
34: import javax.swing.JComponent;
35:
36: import org.jvnet.substance.SubstanceLookAndFeel;
37: import org.jvnet.substance.theme.SubstanceTheme;
38:
39: /**
40: * Base interface for grip painters.
41: *
42: * @author Kirill Grouchnikov
43: * @see SubstanceLookAndFeel#GRIP_PAINTER
44: */
45: public interface GripPainter {
46: /**
47: * Paints the grip.
48: *
49: * @param comp
50: * The associated component.
51: * @param graphics
52: * Graphics to paint on.
53: * @param theme
54: * Theme for the grip painting.
55: * @param gripArea
56: * The area of the scroll thumb. The grip painting <b>must not</b>
57: * exceed this area.
58: * @param isGripVertical
59: * <code>true</code>, if the scroll bar is vertical,
60: * <code>false</code> otherwise.
61: * @param gripOrientation
62: * Orientation of the component. Right-to-left painting algorithm
63: * can consult this parameter as necessary.
64: */
65: public void paintGrip(JComponent comp, Graphics graphics,
66: SubstanceTheme theme, Rectangle gripArea,
67: boolean isGripVertical, ComponentOrientation gripOrientation);
68:
69: /**
70: * Returns the display name of this grip painter.
71: *
72: * @return Display name of this grip painter.
73: */
74: public String getDisplayName();
75: }
|