aboutsummaryrefslogtreecommitdiff
path: root/src/com/wordpress/tipsforjava/swing/StretchIcon.java
blob: 667f1cd80bf44681cba88a8cea24131b227a3afd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
/**
 * @(#)StretchIcon.java	1.0 03/27/12
 */
package com.wordpress.tipsforjava.swing;

import java.awt.Component;
import java.awt.Container;
import java.awt.Graphics;
import java.awt.Image;
import java.awt.Insets;
import java.awt.image.ImageObserver;
import java.net.URL;
import javax.swing.ImageIcon;

/**
 * An <CODE>Icon</CODE> that scales its image to fill the component area,
 * excluding any border or insets, optionally maintaining the image's aspect
 * ratio by padding and centering the scaled image horizontally or vertically.
 * <P>
 * The class is a drop-in replacement for <CODE>ImageIcon</CODE>.
 * <P>
 * As the size of the Icon is determined by the size of the component in which
 * it is displayed, <CODE>StretchIcon</CODE> must only be used in conjunction
 * with a component and layout that does not depend on the size of the
 * component's Icon.
 * 
 * @version 1.0 03/22/12
 * @author Darryl
 */
public class StretchIcon extends ImageIcon {

	/**
	 * Determines whether the aspect ratio of the image is maintained. Set to
	 * <code>false</code> to distort the image to fill the component.
	 */
	protected boolean proportionate = true;

	/**
	 * Creates a <CODE>StretchIcon</CODE> from an array of bytes.
	 * 
	 * @param imageData
	 *            an array of pixels in an image format supported by the AWT
	 *            Toolkit, such as GIF, JPEG, or (as of 1.3) PNG
	 * 
	 * @see ImageIcon#ImageIcon(byte[])
	 */
	public StretchIcon(byte[] imageData) {
		super(imageData);
	}

	/**
	 * Creates a <CODE>StretchIcon</CODE> from an array of bytes with the
	 * specified behavior.
	 * 
	 * @param imageData
	 *            an array of pixels in an image format supported by the AWT
	 *            Toolkit, such as GIF, JPEG, or (as of 1.3) PNG
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(byte[])
	 */
	public StretchIcon(byte[] imageData, boolean proportionate) {
		super(imageData);
		this.proportionate = proportionate;
	}

	/**
	 * Creates a <CODE>StretchIcon</CODE> from an array of bytes.
	 * 
	 * @param imageData
	 *            an array of pixels in an image format supported by the AWT
	 *            Toolkit, such as GIF, JPEG, or (as of 1.3) PNG
	 * @param description
	 *            a brief textual description of the image
	 * 
	 * @see ImageIcon#ImageIcon(byte[], java.lang.String)
	 */
	public StretchIcon(byte[] imageData, String description) {
		super(imageData, description);
	}

	/**
	 * Creates a <CODE>StretchIcon</CODE> from an array of bytes with the
	 * specified behavior.
	 * 
	 * @see ImageIcon#ImageIcon(byte[])
	 * @param imageData
	 *            an array of pixels in an image format supported by the AWT
	 *            Toolkit, such as GIF, JPEG, or (as of 1.3) PNG
	 * @param description
	 *            a brief textual description of the image
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(byte[], java.lang.String)
	 */
	public StretchIcon(byte[] imageData, String description, boolean proportionate) {
		super(imageData, description);
		this.proportionate = proportionate;
	}

	/**
	 * Creates a StretchIcon from the image.
	 * 
	 * @param image
	 *            the image
	 * 
	 * @see ImageIcon#ImageIcon(java.awt.Image)
	 */
	public StretchIcon(Image image) {
		super(image);
	}

	/**
	 * Creates a StretchIcon from the image with the specifiec behavior.
	 * 
	 * @param image
	 *            the image
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(java.awt.Image)
	 */
	public StretchIcon(Image image, boolean proportionate) {
		super(image);
		this.proportionate = proportionate;
	}

	/**
	 * Creates a StretchIcon from the image.
	 * 
	 * @param image
	 *            the image
	 * @param description
	 *            a brief textual description of the image
	 * 
	 * @see ImageIcon#ImageIcon(java.awt.Image, java.lang.String)
	 */
	public StretchIcon(Image image, String description) {
		super(image, description);
	}

	/**
	 * Creates a StretchIcon from the image with the specified behavior.
	 * 
	 * @param image
	 *            the image
	 * @param description
	 *            a brief textual description of the image
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(java.awt.Image, java.lang.String)
	 */
	public StretchIcon(Image image, String description, boolean proportionate) {
		super(image, description);
		this.proportionate = proportionate;
	}

	/**
	 * Creates a StretchIcon from the specified file.
	 * 
	 * @param filename
	 *            a String specifying a filename or path
	 * 
	 * @see ImageIcon#ImageIcon(java.lang.String)
	 */
	public StretchIcon(String filename) {
		super(filename);
	}

	/**
	 * Creates a StretchIcon from the specified file with the specified
	 * behavior.
	 * 
	 * @param filename
	 *            a String specifying a filename or path
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(java.lang.String)
	 */
	public StretchIcon(String filename, boolean proportionate) {
		super(filename);
		this.proportionate = proportionate;
	}

	/**
	 * Creates a StretchIcon from the specified file.
	 * 
	 * @param filename
	 *            a String specifying a filename or path
	 * @param description
	 *            a brief textual description of the image
	 * 
	 * @see ImageIcon#ImageIcon(java.lang.String, java.lang.String)
	 */
	public StretchIcon(String filename, String description) {
		super(filename, description);
	}

	/**
	 * Creates a StretchIcon from the specified file with the specified
	 * behavior.
	 * 
	 * @param filename
	 *            a String specifying a filename or path
	 * @param description
	 *            a brief textual description of the image
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(java.awt.Image, java.lang.String)
	 */
	public StretchIcon(String filename, String description, boolean proportionate) {
		super(filename, description);
		this.proportionate = proportionate;
	}

	/**
	 * Creates a StretchIcon from the specified URL.
	 * 
	 * @param location
	 *            the URL for the image
	 * 
	 * @see ImageIcon#ImageIcon(java.net.URL)
	 */
	public StretchIcon(URL location) {
		super(location);
	}

	/**
	 * Creates a StretchIcon from the specified URL with the specified behavior.
	 * 
	 * @param location
	 *            the URL for the image
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(java.net.URL)
	 */
	public StretchIcon(URL location, boolean proportionate) {
		super(location);
		this.proportionate = proportionate;
	}

	/**
	 * Creates a StretchIcon from the specified URL.
	 * 
	 * @param location
	 *            the URL for the image
	 * @param description
	 *            a brief textual description of the image
	 * 
	 * @see ImageIcon#ImageIcon(java.net.URL, java.lang.String)
	 */
	public StretchIcon(URL location, String description) {
		super(location, description);
	}

	/**
	 * Creates a StretchIcon from the specified URL with the specified behavior.
	 * 
	 * @param location
	 *            the URL for the image
	 * @param description
	 *            a brief textual description of the image
	 * @param proportionate
	 *            <code>true</code> to retain the image's aspect ratio,
	 *            <code>false</code> to allow distortion of the image to fill
	 *            the component.
	 * 
	 * @see ImageIcon#ImageIcon(java.net.URL, java.lang.String)
	 */
	public StretchIcon(URL location, String description, boolean proportionate) {
		super(location, description);
		this.proportionate = proportionate;
	}

	/**
	 * Paints the icon. The image is reduced or magnified to fit the component
	 * to which it is painted.
	 * <P>
	 * If the proportion has not been specified, or has been specified as
	 * <code>true</code>, the aspect ratio of the image will be preserved by
	 * padding and centering the image horizontally or vertically. Otherwise the
	 * image may be distorted to fill the component it is painted to.
	 * <P>
	 * If this icon has no image observer,this method uses the <code>c</code>
	 * component as the observer.
	 * 
	 * @param c
	 *            the component to which the Icon is painted. This is used as
	 *            the observer if this icon has no image observer
	 * @param g
	 *            the graphics context
	 * @param x
	 *            not used.
	 * @param y
	 *            not used.
	 * 
	 * @see ImageIcon#paintIcon(java.awt.Component, java.awt.Graphics, int, int)
	 */
	@Override
	public synchronized void paintIcon(Component c, Graphics g, int x, int y) {
		if (getImage() == null) {
			return;
		}
		Insets insets = ((Container) c).getInsets();
		x = insets.left;
		y = insets.top;

		int w = c.getWidth() - x - insets.right;
		int h = c.getHeight() - y - insets.bottom;
		Image image = getImage();

		if (proportionate) {
			int iw = image.getWidth(c);
			int ih = image.getHeight(c);

			if (iw * h < ih * w) {
				iw = (h * iw) / ih;
				x += (w - iw) / 2;
				w = iw;
			} else {
				ih = (w * ih) / iw;
				y += (h - ih) / 2;
				h = ih;
			}
		}

		ImageObserver io = getImageObserver();
		g.drawImage(image, x, y, w, h, io == null ? c : io);
	}

	/**
	 * Overridden to return 0. The size of this Icon is determined by the size
	 * of the component.
	 * 
	 * @return 0
	 */
	@Override
	public int getIconWidth() {
		return 0;
	}

	/**
	 * Overridden to return 0. The size of this Icon is determined by the size
	 * of the component.
	 * 
	 * @return 0
	 */
	@Override
	public int getIconHeight() {
		return 0;
	}
}