1 /*
2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package sun.swing;
27
28 import javax.swing.JComponent;
29 import java.awt.Cursor;
30
31 /**
32 * The interface by means of which the {@link JLightweightFrame} class
33 * communicates to its client application.
34 * <p>
35 * The client application implements this interface so it can response
36 * to requests and process notifications from {@code JLightweightFrame}.
37 * An implementation of this interface is associated with a {@code
38 * JLightweightFrame} instance via the {@link JLightweightFrame#setContent}
39 * method.
40 *
41 * A hierarchy of components contained in the {@code JComponent} instance
42 * returned by the {@link #getComponent} method should not contain any
43 * heavyweight components, otherwise {@code JLightweightFrame} may fail
44 * to paint it.
45 *
46 * @author Artem Ananiev
47 * @author Anton Tarasov
48 * @author Jim Graham
49 */
50 public interface LightweightContent {
51
52 /**
53 * The client application overrides this method to return the {@code
54 * JComponent} instance which the {@code JLightweightFrame} container
55 * will paint as its lightweight content. A hierarchy of components
56 * contained in this component should not contain any heavyweight objects.
57 *
58 * @return the component to paint
59 */
60 public JComponent getComponent();
61
62 /**
63 * {@code JLightweightFrame} calls this method to notify the client
64 * application that it acquires the paint lock. The client application
65 * should implement the locking mechanism in order to synchronize access
66 * to the content image data, shared between {@code JLightweightFrame}
67 * and the client application.
68 *
69 * @see #paintUnlock
70 */
71 public void paintLock();
72
73 /**
74 * {@code JLightweightFrame} calls this method to notify the client
75 * application that it releases the paint lock. The client application
76 * should implement the locking mechanism in order to synchronize access
77 * to the content image data, shared between {@code JLightweightFrame}
78 * and the client application.
79 *
80 * @see #paintLock
81 */
82 public void paintUnlock();
83
84 /**
85 * {@code JLightweightFrame} calls this method to notify the client
86 * application that a new data buffer has been set as a content pixel
87 * buffer. Typically this occurs when a buffer of a larger size is
88 * created in response to a content resize event.
89 * <p>
90 * The method reports a reference to the pixel data buffer, the content
91 * image bounds within the buffer and the line stride of the buffer.
92 * These values have the following correlation.
93 * The {@code width} and {@code height} matches the layout size of the content
94 * (the component returned from the {@link #getComponent} method). The
95 * {@code x} and {@code y} is the origin of the content, {@code (0, 0)}
96 * in the layout coordinate space of the content, appearing at
97 * {@code data[y * scale * linestride + x * scale]} in the buffer.
98 * A pixel with indices {@code (i, j)}, where {@code (0 <= i < width)} and
99 * {@code (0 <= j < height)}, in the layout coordinate space of the content
100 * is represented by a {@code scale^2} square of pixels in the physical
101 * coordinate space of the buffer. The top-left corner of the square has the
102 * following physical coordinate in the buffer:
103 * {@code data[(y + j) * scale * linestride + (x + i) * scale]}.
104 *
105 * @param data the content pixel data buffer of INT_ARGB_PRE type
106 * @param x the logical x coordinate of the image
107 * @param y the logical y coordinate of the image
108 * @param width the logical width of the image
109 * @param height the logical height of the image
110 * @param linestride the line stride of the pixel buffer
111 * @param scale the scale factor of the pixel buffer
112 */
113 default public void imageBufferReset(int[] data,
114 int x, int y,
115 int width, int height,
116 int linestride,
117 int scale)
118 {
119 imageBufferReset(data, x, y, width, height, linestride);
120 }
121
122 /**
123 * The default implementation for #imageBufferReset uses a hard-coded value
124 * of 1 for the scale factor. Both the old and the new methods provide
125 * default implementations in order to allow a client application to run
126 * with any JDK version without breaking backward compatibility.
127 */
128 default public void imageBufferReset(int[] data,
129 int x, int y,
130 int width, int height,
131 int linestride)
132 {
133 imageBufferReset(data, x, y, width, height, linestride, 1);
134 }
135
136 /**
137 * {@code JLightweightFrame} calls this method to notify the client
138 * application that the content image bounds have been changed within the
139 * image's pixel buffer.
140 *
141 * @param x the x coordinate of the image
142 * @param y the y coordinate of the image
143 * @param width the width of the image
144 * @param height the height of the image
145 *
146 * @see #imageBufferReset
147 */
148 public void imageReshaped(int x, int y, int width, int height);
149
150 /**
151 * {@code JLightweightFrame} calls this method to notify the client
152 * application that a part of the content image, or the whole image has
153 * been updated. The method reports bounds of the rectangular dirty region.
154 * The {@code dirtyX} and {@code dirtyY} is the origin of the dirty
155 * rectangle, which is relative to the origin of the content, appearing
156 * at {@code data[(y + dirtyY] * linestride + (x + dirtyX)]} in the pixel
157 * buffer (see {@link #imageBufferReset}). All indices
158 * {@code data[(y + dirtyY + j) * linestride + (x + dirtyX + i)]} where
159 * {@code (0 <= i < dirtyWidth)} and {@code (0 <= j < dirtyHeight)}
160 * will represent valid pixel data, {@code (i, j)} in the coordinate space
161 * of the dirty rectangle.
162 *
163 * @param dirtyX the x coordinate of the dirty rectangle,
164 * relative to the image origin
165 * @param dirtyY the y coordinate of the dirty rectangle,
166 * relative to the image origin
167 * @param dirtyWidth the width of the dirty rectangle
168 * @param dirtyHeight the height of the dirty rectangle
169 *
170 * @see #imageBufferReset
171 * @see #imageReshaped
172 */
173 public void imageUpdated(int dirtyX, int dirtyY,
174 int dirtyWidth, int dirtyHeight);
175
176 /**
177 * {@code JLightweightFrame} calls this method to notify the client
178 * application that the frame has grabbed focus.
179 */
180 public void focusGrabbed();
181
182 /**
183 * {@code JLightweightFrame} calls this method to notify the client
184 * application that the frame has ungrabbed focus.
185 */
186 public void focusUngrabbed();
187
188 /**
189 * {@code JLightweightFrame} calls this method to notify the client
190 * application that the content preferred size has changed.
191 */
192 public void preferredSizeChanged(int width, int height);
193
194 /**
195 * {@code JLightweightFrame} calls this method to notify the client
196 * application that the content maximum size has changed.
197 */
198 public void maximumSizeChanged(int width, int height);
199
200 /**
201 * {@code JLightweightFrame} calls this method to notify the client
202 * application that the content minimum size has changed.
203 */
204 public void minimumSizeChanged(int width, int height);
205
206 /**
207 * {@code JLightweightFrame} calls this method to notify the client
208 * application that in needs to set a cursor
209 * @param cursor a cursor to set
210 */
211 default public void setCursor(Cursor cursor) { }
212 }