Source Code Cross Referenced for SubstanceTextPainter.java in  » Swing-Library » substance-look-feel » org » jvnet » substance » painter » text » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Swing Library » substance look feel » org.jvnet.substance.painter.text 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


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.painter.text;
031:
032:        import java.awt.*;
033:        import java.awt.image.BufferedImage;
034:
035:        import javax.swing.JComponent;
036:
037:        /**
038:         * Base interface for Substance text painters.
039:         * 
040:         * @author Kirill Grouchnikov
041:         * @since version 4.2
042:         */
043:        public interface SubstanceTextPainter {
044:            /**
045:             * Callback for custom background painting.
046:             * 
047:             * @author Kirill Grouchnikov
048:             */
049:            public static interface BackgroundPaintingCallback {
050:                /**
051:                 * Performs custom background painting on the specified surface.
052:                 * 
053:                 * @param g
054:                 *            Graphic context.
055:                 */
056:                public void paintBackground(Graphics g);
057:            }
058:
059:            /**
060:             * Background painting callback that draws an image at the specified
061:             * location.
062:             * 
063:             * @author Kirill Grouchnikov
064:             */
065:            public static class ImageBackgroundPaintingCallback implements 
066:                    BackgroundPaintingCallback {
067:                /**
068:                 * Image to paint.
069:                 */
070:                private BufferedImage backgroundImage;
071:
072:                /**
073:                 * Image anchor.
074:                 */
075:                private Point backgroundImageAnchor;
076:
077:                /**
078:                 * Alpha channel.
079:                 */
080:                private float alpha;
081:
082:                /**
083:                 * Creates a new background painting callback.
084:                 * 
085:                 * @param backgroundImage
086:                 *            Image to paint.
087:                 * @param backgroundImageAnchor
088:                 *            Image anchor.
089:                 * @param alpha
090:                 *            Alpha channel.
091:                 */
092:                public ImageBackgroundPaintingCallback(
093:                        BufferedImage backgroundImage,
094:                        Point backgroundImageAnchor, float alpha) {
095:                    super ();
096:                    this .backgroundImage = backgroundImage;
097:                    this .backgroundImageAnchor = backgroundImageAnchor;
098:                    this .alpha = alpha;
099:                }
100:
101:                /*
102:                 * (non-Javadoc)
103:                 * 
104:                 * @see org.jvnet.substance.painter.text.SubstanceTextPainter.BackgroundPaintingCallback#paintBackground(java.awt.Graphics)
105:                 */
106:                public void paintBackground(Graphics g) {
107:                    Graphics2D g2d = (Graphics2D) g.create();
108:                    g2d.setComposite(AlphaComposite.getInstance(
109:                            AlphaComposite.SRC_OVER, this .alpha));
110:                    if (this .backgroundImageAnchor == null)
111:                        g2d.drawImage(this .backgroundImage, 0, 0, null);
112:                    else
113:                        g2d.drawImage(this .backgroundImage,
114:                                this .backgroundImageAnchor.x,
115:                                this .backgroundImageAnchor.y, null);
116:                    g2d.dispose();
117:                }
118:            }
119:
120:            /**
121:             * Re-initializes the contents of this painter. Is usually called at the
122:             * beginning of the component painting cycle. The painter implementation is
123:             * expected to remove all registered callbacks.
124:             * 
125:             * @param comp
126:             *            Component.
127:             * @param clip
128:             *            Clip to apply. The painter implementation should respect this
129:             *            clip, especially on components such as lists or tables that
130:             *            use cell renderers. In these components, the specific cell is
131:             *            usually much smaller than the whole component, and the
132:             *            painting is done on each visible cell in a loop.
133:             * @param toEnforceRenderOnNoTexts
134:             *            If <code>true</code>, the painter implementation <b>must</b>
135:             *            fill the background and invoke all callbacks even when there
136:             *            are no attached texts or all texts are empty.
137:             * @see AbstractTextPainter
138:             */
139:            public void init(JComponent comp, Rectangle clip,
140:                    boolean toEnforceRenderOnNoTexts);
141:
142:            /**
143:             * Returns indication whether this painter requires background to be fully
144:             * set before painting the text (with {@link #renderSurface(Graphics)}).
145:             * 
146:             * @return <code>true</code> if this painter requires background to be
147:             *         fully set before painting the text, <code>false</code>
148:             *         otherwise.
149:             */
150:            public boolean needsBackgroundImage();
151:
152:            /**
153:             * Sets the fill color of the background.
154:             * 
155:             * @param comp
156:             *            Component.
157:             * @param backgroundFillColor
158:             *            Fill color for the background.
159:             * @param toOverlayWatermark
160:             *            If <code>true</code>, the background fill should be
161:             *            overlayed with the current watermark.
162:             * @param watermarkOffsetX
163:             *            The X offset for the watermark relative to the screen position
164:             *            of the component. This is relevant for cell-based components
165:             *            such as lists, tables and trees.
166:             * @param watermarkOffsetY
167:             *            The Y offset for the watermark relative to the screen position
168:             *            of the component. This is relevant for cell-based components
169:             *            such as lists, tables and trees.
170:             */
171:            public void setBackgroundFill(JComponent comp,
172:                    Color backgroundFillColor, boolean toOverlayWatermark,
173:                    int watermarkOffsetX, int watermarkOffsetY);
174:
175:            /**
176:             * Attaches the specified background painting callback.
177:             * 
178:             * @param backgroundPaintingCallback
179:             *            Background painting callback to attach.
180:             */
181:            public void attachCallback(
182:                    BackgroundPaintingCallback backgroundPaintingCallback);
183:
184:            /**
185:             * Attaches the specified text to paint.
186:             * 
187:             * @param comp
188:             *            Component.
189:             * @param textRect
190:             *            Text rectangle.
191:             * @param text
192:             *            The text itself.
193:             * @param mnemonicIndex
194:             *            Optional mnemonic index. Can be -1 if no mnemonic.
195:             * @param font
196:             *            Font for this text.
197:             * @param color
198:             *            Color for this text.
199:             * @param clip
200:             *            Clip rectangle for this text.
201:             */
202:            public void attachText(JComponent comp, Rectangle textRect,
203:                    String text, int mnemonicIndex, java.awt.Font font,
204:                    java.awt.Color color, java.awt.Rectangle clip);
205:
206:            /**
207:             * Attaches the specified vertical text to paint.
208:             * 
209:             * @param comp
210:             *            Component.
211:             * @param textRect
212:             *            Text rectangle.
213:             * @param text
214:             *            The text itself.
215:             * @param mnemonicIndex
216:             *            Optional mnemonic index. Can be -1 if no mnemonic.
217:             * @param font
218:             *            Font for this text.
219:             * @param color
220:             *            Color for this text.
221:             * @param clip
222:             *            Clip rectangle for this text.
223:             * @param isFromBottomToTop
224:             *            If <code>true</code>, the text will be painted from bottom
225:             *            to top (so that the top of the letters is on the left). If
226:             *            <code>false</code>, the text will be painted from top to
227:             *            bottom (so that the top of the letters is on the right).
228:             */
229:            public void attachVerticalText(JComponent comp, Rectangle textRect,
230:                    String text, int mnemonicIndex, java.awt.Font font,
231:                    java.awt.Color color, java.awt.Rectangle clip,
232:                    boolean isFromBottomToTop);
233:
234:            /**
235:             * Paints the surface. The painter implementation should respect the clip
236:             * set in {@link #init(JComponent, Rectangle)}, background fill set in
237:             * {@link #setBackgroundFill(JComponent, Color, boolean, int, int)}, invoke
238:             * the background callbacks added with
239:             * {@link #attachCallback(BackgroundPaintingCallback)} and paint all the
240:             * texts added with
241:             * {@link #attachText(JComponent, Rectangle, String, int, Font, Color)}.
242:             * 
243:             * @param g
244:             *            Graphic context.
245:             */
246:            public void renderSurface(Graphics g);
247:
248:            /**
249:             * Returns <code>true</code> if this text painter uses native font
250:             * rendering.
251:             * 
252:             * @return <code>true</code> if this text painter uses native font
253:             *         rendering.
254:             */
255:            public boolean isNative();
256:
257:            /**
258:             * Disposes the resources allocated by this text painter.
259:             */
260:            public void dispose();
261:
262:            public java.awt.Dimension getTextBounds(Component comp,
263:                    java.awt.Font font, String text);
264:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.