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. The method reports 89 * a reference to the pixel data buffer, the content image bounds 90 * within the buffer and the line stride of the buffer. These values 91 * have the following correlation. 92 * <p> 93 * The {@code width} and {@code height} matches the 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 coordinate space of the content, appearing at 97 * {@code data[y * linestride + x]} in the buffer. All indices 98 * {@code data[(y + j) * linestride + (x + i)]} where 99 * {@code (0 <= i < width)} and {@code (0 <= j < height)} will represent 100 * valid pixel data, {@code (i, j)} in the coordinate space of the content. 101 * 102 * @param data the content pixel data buffer of INT_ARGB_PRE type 103 * @param x the x coordinate of the image 104 * @param y the y coordinate of the image 105 * @param width the width of the image 106 * @param height the height of the image 107 * @param linestride the line stride of the pixel buffer 108 */ 109 public void imageBufferReset(int[] data, 110 int x, int y, 111 int width, int height, 112 int linestride); 113 114 /** 115 * {@code JLightweightFrame} calls this method to notify the client 116 * application that the content image bounds have been changed within the 117 * image's pixel buffer. 118 * 119 * @param x the x coordinate of the image 120 * @param y the y coordinate of the image 121 * @param width the width of the image 122 * @param height the height of the image 123 * 124 * @see #imageBufferReset 125 */ 126 public void imageReshaped(int x, int y, int width, int height); 127 128 /** 129 * {@code JLightweightFrame} calls this method to notify the client 130 * application that a part of the content image, or the whole image has 131 * been updated. The method reports bounds of the rectangular dirty region. 132 * The {@code dirtyX} and {@code dirtyY} is the origin of the dirty 133 * rectangle, which is relative to the origin of the content, appearing 134 * at {@code data[(y + dirtyY] * linestride + (x + dirtyX)]} in the pixel 135 * buffer (see {@link #imageBufferReset}). All indices 136 * {@code data[(y + dirtyY + j) * linestride + (x + dirtyX + i)]} where 137 * {@code (0 <= i < dirtyWidth)} and {@code (0 <= j < dirtyHeight)} 138 * will represent valid pixel data, {@code (i, j)} in the coordinate space 139 * of the dirty rectangle. 140 * 141 * @param dirtyX the x coordinate of the dirty rectangle, 142 * relative to the image origin 143 * @param dirtyY the y coordinate of the dirty rectangle, 144 * relative to the image origin 145 * @param dirtyWidth the width of the dirty rectangle 146 * @param dirtyHeight the height of the dirty rectangle 147 * 148 * @see #imageBufferReset 149 * @see #imageReshaped 150 */ 151 public void imageUpdated(int dirtyX, int dirtyY, 152 int dirtyWidth, int dirtyHeight); 153 154 /** 155 * {@code JLightweightFrame} calls this method to notify the client 156 * application that the frame has grabbed focus. 157 */ 158 public void focusGrabbed(); 159 160 /** 161 * {@code JLightweightFrame} calls this method to notify the client 162 * application that the frame has ungrabbed focus. 163 */ 164 public void focusUngrabbed(); 165 166 /** 167 * {@code JLightweightFrame} calls this method to notify the client 168 * application that the content preferred size has changed. 169 */ 170 public void preferredSizeChanged(int width, int height); 171 172 /** 173 * {@code JLightweightFrame} calls this method to notify the client 174 * application that the content maximum size has changed. 175 */ 176 public void maximumSizeChanged(int width, int height); 177 178 /** 179 * {@code JLightweightFrame} calls this method to notify the client 180 * application that the content minimum size has changed. 181 */ 182 public void minimumSizeChanged(int width, int height); 183 184 /** 185 * {@code JLightweightFrame} calls this method to notify the client 186 * application that in needs to set a cursor 187 * @param cursor a cursor to set 188 */ 189 default public void setCursor(Cursor cursor) { } 190 }