File: DashedOutline.java

package info (click to toggle)
libpj-java 0.0~20150107%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 13,396 kB
  • sloc: java: 99,543; ansic: 987; sh: 153; xml: 26; makefile: 10; sed: 4
file content (350 lines) | stat: -rw-r--r-- 8,983 bytes parent folder | download | duplicates (2)
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
//******************************************************************************
//
// File:    DashedOutline.java
// Package: edu.rit.draw.item
// Unit:    Class edu.rit.draw.item.DashedOutline
//
// This Java source file is copyright (C) 2006 by Alan Kaminsky. All rights
// reserved. For further information, contact the author, Alan Kaminsky, at
// ark@cs.rit.edu.
//
// This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
// software; you can redistribute it and/or modify it under the terms of the GNU
// General Public License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// PJ is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
// A PARTICULAR PURPOSE. See the GNU General Public License for more details.
//
// Linking this library statically or dynamically with other modules is making a
// combined work based on this library. Thus, the terms and conditions of the
// GNU General Public License cover the whole combination.
//
// As a special exception, the copyright holders of this library give you
// permission to link this library with independent modules to produce an
// executable, regardless of the license terms of these independent modules, and
// to copy and distribute the resulting executable under terms of your choice,
// provided that you also meet, for each linked independent module, the terms
// and conditions of the license of that module. An independent module is a
// module which is not derived from or based on this library. If you modify this
// library, you may extend this exception to your version of the library, but
// you are not obligated to do so. If you do not wish to do so, delete this
// exception statement from your version.
//
// A copy of the GNU General Public License is provided in the file gpl.txt. You
// may also obtain a copy of the GNU General Public License on the World Wide
// Web at http://www.gnu.org/licenses/gpl.html.
//
//******************************************************************************

package edu.rit.draw.item;

import java.awt.BasicStroke;
import java.awt.Graphics2D;

import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

/**
 * Class DashedOutline provides an object that outlines an area in a {@linkplain
 * DrawingItem} with a square-cornered dashed stroke in a solid color.
 *
 * @author  Alan Kaminsky
 * @version 12-Jul-2006
 */
public class DashedOutline
	implements Outline
	{

// Exported constants.

	/**
	 * The normal dashed outline width (1).
	 */
	public static final float NORMAL_WIDTH = 1.0f;

	/**
	 * The normal dashed outline fill paint (black).
	 */
	public static final Fill NORMAL_FILL = ColorFill.BLACK;

	/**
	 * The normal dashed outline down factor (10).
	 */
	public static final float NORMAL_DOWN_FACTOR = 10.0f;

	/**
	 * The normal dashed outline up factor (6).
	 */
	public static final float NORMAL_UP_FACTOR = 6.0f;

	/**
	 * The normal dashed outline (width = 1, fill paint = black, down factor =
	 * 5, up factor = 3).
	 */
	public static final DashedOutline NORMAL_OUTLINE = new DashedOutline();

// Hidden data members.

	private static final long serialVersionUID = 8450835114943482027L;

	private float myWidth;
	private Fill myFill;
	private float myDownFactor;
	private float myUpFactor;
	private transient BasicStroke myStroke;

// Exported constructors.

	/**
	 * Construct a new dashed outline object with the normal width (1), the
	 * normal fill paint (black), the normal down factor (10), and the normal up
	 * factor (6).
	 */
	public DashedOutline()
		{
		myWidth = NORMAL_WIDTH;
		myFill = NORMAL_FILL;
		myDownFactor = NORMAL_DOWN_FACTOR;
		myUpFactor = NORMAL_UP_FACTOR;
		computeStroke();
		}

	/**
	 * Construct a new dashed outline object with the same width, fill paint,
	 * down factor, and up factor as the given dashed outline object.
	 *
	 * @param  theOutline  Dashed outline object.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>theOutline</TT> is null.
	 */
	public DashedOutline
		(DashedOutline theOutline)
		{
		myWidth = theOutline.myWidth;
		myFill = theOutline.myFill;
		myDownFactor = theOutline.myDownFactor;
		myUpFactor = theOutline.myUpFactor;
		computeStroke();
		}

// Exported operations.

	/**
	 * Returns this dashed outline object's width.
	 *
	 * @return  Width.
	 */
	public float width()
		{
		return myWidth;
		}

	/**
	 * Set this dashed outline object's width.
	 *
	 * @param  theWidth  Width.
	 *
	 * @return  This dashed outline object.
	 *
	 * @exception  IllegalArgumentException
	 *     (unchecked exception) Thrown if <TT>theWidth</TT> is less than or
	 *     equal to 0.
	 */
	public DashedOutline width
		(float theWidth)
		{
		if (theWidth <= 0.0)
			{
			throw new IllegalArgumentException();
			}
		myWidth = theWidth;
		computeStroke();
		return this;
		}

	/**
	 * Returns this dashed outline object's fill paint.
	 *
	 * @return  Fill paint.
	 */
	public Fill fill()
		{
		return myFill;
		}

	/**
	 * Set this dashed outline object's fill paint.
	 *
	 * @param  theFill  Fill paint.
	 *
	 * @return  This dashed outline object.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>theFill</TT> is null.
	 */
	public DashedOutline fill
		(Fill theFill)
		{
		if (theFill == null)
			{
			throw new NullPointerException();
			}
		myFill = theFill;
		computeStroke();
		return this;
		}

	/**
	 * Returns this dashed outline object's down factor. The down factor is the
	 * length, relative to this dashed outline object's width, that the "pen" is
	 * "down" drawing a dash.
	 *
	 * @return  Down factor.
	 */
	public float down()
		{
		return myDownFactor;
		}

	/**
	 * Set this dashed outline object's down factor. The down factor is the
	 * length, relative to this dashed outline object's width, that the "pen" is
	 * "down" drawing a dash.
	 *
	 * @param  theDownFactor  Down factor.
	 *
	 * @return  This dashed outline object.
	 *
	 * @exception  IllegalArgumentException
	 *     (unchecked exception) Thrown if <TT>theDownFactor</TT> is less than
	 *     or equal to 0.
	 */
	public DashedOutline down
		(float theDownFactor)
		{
		if (theDownFactor <= 0.0f)
			{
			throw new IllegalArgumentException();
			}
		myDownFactor = theDownFactor;
		computeStroke();
		return this;
		}

	/**
	 * Returns this dashed outline object's up factor. The up factor is the
	 * length, relative to this dashed outline object's width, that the "pen" is
	 * "up" between dashes.
	 *
	 * @return  Up factor.
	 */
	public float up()
		{
		return myUpFactor;
		}

	/**
	 * Set this dashed outline object's up factor. The down factor is the
	 * length, relative to this dashed outline object's width, that the "pen" is
	 * "up" between dashes.
	 *
	 * @param  theUpFactor  Up factor.
	 *
	 * @return  This dashed outline object.
	 *
	 * @exception  IllegalArgumentException
	 *     (unchecked exception) Thrown if <TT>theUpFactor</TT> is less than
	 *     or equal to 0.
	 */
	public DashedOutline up
		(float theUpFactor)
		{
		if (theUpFactor <= 0.0f)
			{
			throw new IllegalArgumentException();
			}
		myUpFactor = theUpFactor;
		computeStroke();
		return this;
		}

	/**
	 * Returns the stroke width of this outline.
	 */
	public float getStrokeWidth()
		{
		return myWidth;
		}

	/**
	 * Set the given graphics context's stroke and paint attributes as specified
	 * by this outline object.
	 *
	 * @param  g2d  2-D graphics context.
	 */
	public void setGraphicsContext
		(Graphics2D g2d)
		{
		g2d.setStroke (myStroke);
		myFill.setGraphicsContext (g2d);
		}

	/**
	 * Write this dashed outline object to the given object output stream.
	 *
	 * @param  out  Object output stream.
	 *
	 * @exception  IOException
	 *     Thrown if an I/O error occurred.
	 */
	public void writeExternal
		(ObjectOutput out)
		throws IOException
		{
		out.writeFloat (myWidth);
		out.writeFloat (myDownFactor);
		out.writeFloat (myUpFactor);
		out.writeObject (myFill);
		}

	/**
	 * Read this dashed outline object from the given object input stream.
	 *
	 * @param  in  Object input stream.
	 *
	 * @exception  IOException
	 *     Thrown if an I/O error occurred.
	 * @exception  ClassNotFoundException
	 *     Thrown if any class needed to deserialize this dashed outline object
	 *     cannot be found.
	 */
	public void readExternal
		(ObjectInput in)
		throws IOException, ClassNotFoundException
		{
		myWidth = in.readFloat();
		myDownFactor = in.readFloat();
		myUpFactor = in.readFloat();
		myFill = (Fill) in.readObject();
		computeStroke();
		}

// Hidden operations.

	private void computeStroke()
		{
		myStroke = 
			new BasicStroke
				(myWidth,
				 BasicStroke.CAP_SQUARE,
				 BasicStroke.JOIN_MITER,
				 10.0f,
				 new float[] {myDownFactor * myWidth, myUpFactor * myWidth},
				 0);
		}

	}