File: DisplayableList.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 (167 lines) | stat: -rw-r--r-- 5,277 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
//******************************************************************************
//
// File:    DisplayableList.java
// Package: edu.rit.swing
// Unit:    Class edu.rit.swing.DisplayableList
//
// This Java source file is copyright (C) 2002-2005 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.swing;

import java.awt.Color;
import java.awt.Graphics2D;
import java.awt.Paint;

import java.awt.geom.Rectangle2D;

import java.util.Vector;

/**
 * Class DisplayableList provides an object that combines a list of separate
 * {@link Displayable </CODE>Displayable<CODE>} objects into a single
 * displayable object.
 * <P>
 * <I>Note:</I> Class DisplayableList is multiple thread safe.
 *
 * @author  Alan Kaminsky
 * @version 20-Jul-2006
 */
public class DisplayableList
	implements Displayable
	{

// Hidden data members.

	private Vector<Displayable> myDisplayList = new Vector<Displayable>();

	private static final Rectangle2D EMPTY = new Rectangle2D.Double();
	private Rectangle2D myBoundingBox = EMPTY;

	private Paint myBackgroundPaint = Color.white;

// Exported constructors.

	/**
	 * Construct a new, empty displayable list.
	 */
	public DisplayableList()
		{
		}

// Exported operations.

	/**
	 * Clear this displayable list.
	 */
	public synchronized void clear()
		{
		myDisplayList.clear();
		myBoundingBox = EMPTY;
		myBackgroundPaint = Color.white;
		}

	/**
	 * Add the given displayable object to the end of this displayable list.
	 *
	 * @param  theDisplayable  Displayable object.
	 *
	 * @exception  NullPointerException
	 *     (unchecked exception) Thrown if <TT>theDisplayable</TT> is null.
	 */
	public synchronized void add
		(Displayable theDisplayable)
		{
		if (theDisplayable == null)
			{
			throw new NullPointerException();
			}
		if (myDisplayList.isEmpty())
			{
			myBackgroundPaint = theDisplayable.getBackgroundPaint();
			}
		myBoundingBox =
			myBoundingBox.createUnion (theDisplayable.getBoundingBox());
		myDisplayList.add (theDisplayable);
		}

// Exported operations implemented from interface Drawable.

	/**
	 * Draw this drawable object in the given graphics context. Upon return from
	 * this method, the given graphics context's state (color, font, transform,
	 * clip, and so on) is the same as it was upon entry to this method.
	 * <P>
	 * The displayable objects in this displayable list are drawn in the order
	 * they were added.
	 *
	 * @param  g2d  2-D graphics context.
	 */
	public synchronized void draw
		(Graphics2D g2d)
		{
		for (Displayable item : myDisplayList)
			{
			item.draw (g2d);
			}
		}

// Exported operations implemented from interface Displayable.

	/**
	 * Returns this displayable object's bounding box. This is the smallest
	 * rectangle that encloses all of this displayable object.
	 * <P>
	 * This method returns the union of the bounding boxes of the displayable
	 * objects in this displayable list. If this displayable list is empty, an
	 * empty rectangle is returned.
	 */
	public synchronized Rectangle2D getBoundingBox()
		{
		return myBoundingBox;
		}

	/**
	 * Returns this displayable object's background paint.
	 * <P>
	 * This method returns the background paint of the first displayable object
	 * in this displayable list. If this displayable list is empty, the color
	 * white is returned.
	 */
	public synchronized Paint getBackgroundPaint()
		{
		return myBackgroundPaint;
		}

	}