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 * When a scale factor greater than one is set on a {@code JLightweightFrame} 91 * ({@link JLightweightFrame#setScaleFactor}), an {@link OffScreenHiDPIImage} 92 * is created to server the pixel buffer. 93 * <p> 94 * The method reports a reference to the pixel data buffer, the content 95 * image bounds within the buffer and the line stride of the buffer. 96 * These values have the following correlation. 97 * The {@code width} and {@code height} matches the layout size of the content 98 * (the component returned from the {@link #getComponent} method). The 99 * {@code x} and {@code y} is the origin of the content, {@code (0, 0)} 100 * in the layout coordinate space of the content, appearing at 101 * {@code data[y * scale * linestride + x * scale]} in the buffer. 102 * A pixel with indices {@code (i, j)}, where {@code (0 <= i < width)} and 103 * {@code (0 <= j < height)}, in the layout coordinate space of the content 104 * is represented by a {@code scale^2} square of pixels in the physical 105 * coordinate space of the buffer. The top-left corner of the square has the 106 * following physical coordinate in the buffer: 107 * {@code data[(y + j) * scale * linestride + (x + i) * scale]}. 108 * 109 * @param data the content pixel data buffer of INT_ARGB_PRE type 110 * @param x the logical x coordinate of the image 111 * @param y the logical y coordinate of the image 112 * @param width the logical width of the image 113 * @param height the logical height of the image 114 * @param linestride the line stride of the pixel buffer 115 * @param scale the scale factor of the pixel buffer 116 */ 117 default public void imageBufferReset(int[] data, 118 int x, int y, 119 int width, int height, 120 int linestride, 121 int scale) 122 { 123 imageBufferReset(data, x, y, width, height, linestride); 124 } 125 126 /** 127 * The default implementation for #imageBufferReset uses a hard-coded value 128 * of 1 for the scale factor. Both the old and the new methods provide 129 * default implementations in order to allow a client application to run 130 * with any JDK version without breaking backward compatibility. 131 */ 132 default public void imageBufferReset(int[] data, 133 int x, int y, 134 int width, int height, 135 int linestride) 136 { 137 imageBufferReset(data, x, y, width, height, linestride, 1); 138 } 139 140 /** 141 * {@code JLightweightFrame} calls this method to notify the client 142 * application that the content image bounds have been changed within the 143 * image's pixel buffer. 144 * 145 * @param x the x coordinate of the image 146 * @param y the y coordinate of the image 147 * @param width the width of the image 148 * @param height the height of the image 149 * 150 * @see #imageBufferReset 151 */ 152 public void imageReshaped(int x, int y, int width, int height); 153 154 /** 155 * {@code JLightweightFrame} calls this method to notify the client 156 * application that a part of the content image, or the whole image has 157 * been updated. The method reports bounds of the rectangular dirty region. 158 * The {@code dirtyX} and {@code dirtyY} is the origin of the dirty 159 * rectangle, which is relative to the origin of the content, appearing 160 * at {@code data[(y + dirtyY] * linestride + (x + dirtyX)]} in the pixel 161 * buffer (see {@link #imageBufferReset}). All indices 162 * {@code data[(y + dirtyY + j) * linestride + (x + dirtyX + i)]} where 163 * {@code (0 <= i < dirtyWidth)} and {@code (0 <= j < dirtyHeight)} 164 * will represent valid pixel data, {@code (i, j)} in the coordinate space 165 * of the dirty rectangle. 166 * 167 * @param dirtyX the x coordinate of the dirty rectangle, 168 * relative to the image origin 169 * @param dirtyY the y coordinate of the dirty rectangle, 170 * relative to the image origin 171 * @param dirtyWidth the width of the dirty rectangle 172 * @param dirtyHeight the height of the dirty rectangle 173 * 174 * @see #imageBufferReset 175 * @see #imageReshaped 176 */ 177 public void imageUpdated(int dirtyX, int dirtyY, 178 int dirtyWidth, int dirtyHeight); 179 180 /** 181 * {@code JLightweightFrame} calls this method to notify the client 182 * application that the frame has grabbed focus. 183 */ 184 public void focusGrabbed(); 185 186 /** 187 * {@code JLightweightFrame} calls this method to notify the client 188 * application that the frame has ungrabbed focus. 189 */ 190 public void focusUngrabbed(); 191 192 /** 193 * {@code JLightweightFrame} calls this method to notify the client 194 * application that the content preferred size has changed. 195 */ 196 public void preferredSizeChanged(int width, int height); 197 198 /** 199 * {@code JLightweightFrame} calls this method to notify the client 200 * application that the content maximum size has changed. 201 */ 202 public void maximumSizeChanged(int width, int height); 203 204 /** 205 * {@code JLightweightFrame} calls this method to notify the client 206 * application that the content minimum size has changed. 207 */ 208 public void minimumSizeChanged(int width, int height); 209 210 /** 211 * {@code JLightweightFrame} calls this method to notify the client 212 * application that in needs to set a cursor 213 * @param cursor a cursor to set 214 */ 215 default public void setCursor(Cursor cursor) { } 216 }