File: OutlinedItem.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 (276 lines) | stat: -rw-r--r-- 7,313 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
//******************************************************************************
//
// File:    OutlinedItem.java
// Package: edu.rit.draw.item
// Unit:    Class edu.rit.draw.item.OutlinedItem
//
// This Java source file is copyright (C) 2008 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 edu.rit.draw.Drawing;

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

/**
 * Class OutlinedItem is the abstract base class for a {@linkplain DrawingItem}
 * that has an outline. Specify <TT>Outline.NONE</TT> for the outline to omit
 * drawing a drawing item's outline.
 * <P>
 * The static <TT>defaultOutline()</TT> method is provided to set the default
 * outline. If the outline is not specified, the current default outline is
 * used.
 *
 * @author  Alan Kaminsky
 * @version 23-Jun-2008
 */
public abstract class OutlinedItem
	extends DrawingItem
	implements Externalizable
	{

// Exported constants.

	/**
	 * The normal outline: Solid, square corners, 1 point wide, black.
	 */
	public static final Outline NORMAL_OUTLINE = SolidOutline.NORMAL_OUTLINE;

// Hidden data members.

	private static final long serialVersionUID = -2644075901753850353L;

	// Outline, or null if the item's outline is not drawn.
	Outline myOutline = theDefaultOutline;

	// The default outline.
	static Outline theDefaultOutline = NORMAL_OUTLINE;

// Exported constructors.

	/**
	 * Construct a new outlined item with the default outline.
	 */
	public OutlinedItem()
		{
		super();
		}

	/**
	 * Construct a new outlined item with the same outline as the given outlined
	 * item.
	 *
	 * @param  theItem  Outlined item.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>theItem</TT> is null.
	 */
	public OutlinedItem
		(OutlinedItem theItem)
		{
		super (theItem);
		myOutline = theItem.myOutline;
		}

// Exported operations.

	/**
	 * Returns the default outline.
	 *
	 * @return  Default outline, or <TT>Outline.NONE</TT>.
	 */
	public static Outline defaultOutline()
		{
		return theDefaultOutline;
		}

	/**
	 * Set the default outline. Before calling this method the first time,
	 * the default outline is solid, square corners, 1 point wide, black.
	 *
	 * @param  theOutline  Default outline, or <TT>Outline.NONE</TT>.
	 */
	public static void defaultOutline
		(Outline theOutline)
		{
		theDefaultOutline = theOutline;
		}

	/**
	 * Returns this outlined item's outline.
	 *
	 * @return  Outline, or <TT>Outline.NONE</TT>.
	 */
	public Outline outline()
		{
		return myOutline;
		}

	/**
	 * Set this outlined item's outline.
	 *
	 * @param  theOutline  Outline, or <TT>Outline.NONE</TT>.
	 *
	 * @return  This outlined item.
	 */
	public OutlinedItem outline
		(Outline theOutline)
		{
		doOutline (theOutline);
		return this;
		}

	/**
	 * Add this outlined item to the end of the default drawing's sequence of
	 * drawing items.
	 *
	 * @return  This outlined item.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if there is no default drawing.
	 *
	 * @see  Drawing#defaultDrawing()
	 */
	public OutlinedItem add()
		{
		doAdd (Drawing.defaultDrawing());
		return this;
		}

	/**
	 * Add this outlined item to the end of the given drawing's sequence of
	 * drawing items.
	 *
	 * @param  theDrawing  Drawing.
	 *
	 * @return  This outlined item.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>theDrawing</TT> is null.
	 */
	public OutlinedItem add
		(Drawing theDrawing)
		{
		doAdd (theDrawing);
		return this;
		}

	/**
	 * Add this outlined item to the beginning of the default drawing's sequence
	 * of drawing items.
	 *
	 * @return  This outlined item.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if there is no default drawing.
	 *
	 * @see  Drawing#defaultDrawing()
	 */
	public OutlinedItem addFirst()
		{
		doAddFirst (Drawing.defaultDrawing());
		return this;
		}

	/**
	 * Add this outlined item to the beginning of the given drawing's sequence
	 * of drawing items.
	 *
	 * @param  theDrawing  Drawing.
	 *
	 * @return  This outlined item.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>theDrawing</TT> is null.
	 */
	public OutlinedItem addFirst
		(Drawing theDrawing)
		{
		doAddFirst (theDrawing);
		return this;
		}

	/**
	 * Write this outlined item 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
		{
		super.writeExternal (out);
		out.writeObject (myOutline);
		}

	/**
	 * Read this outlined item 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 outlined item cannot
	 *     be found.
	 */
	public void readExternal
		(ObjectInput in)
		throws IOException, ClassNotFoundException
		{
		super.readExternal (in);
		myOutline = (Outline) in.readObject();
		}

// Hidden operations.

	/**
	 * Set this outlined item's outline.
	 *
	 * @param  theOutline  Outline, or <TT>Outline.NONE</TT>.
	 */
	void doOutline
		(Outline theOutline)
		{
		myOutline = theOutline;
		}

	}