Revision 20100 branches/v10/libraries/libFMap/src/com/iver/cit/gvsig/fmap/tools/CompoundBehavior.java

View differences:

CompoundBehavior.java
54 54

  
55 55

  
56 56
/**
57
 * Behavior mediante el que se pueden combinar varios behaviors
58
 * a la vez en un mismo MapControl
57
 * <p>Allows having multiple behaviors when user works with the associated
58
 *  <code>MapControl</code>. Each one with its associated tool listener.</p>
59 59
 *
60 60
 * @author Fernando Gonz?lez Cort?s
61 61
 */
62 62
public class CompoundBehavior extends Behavior {
63
	/**
64
	 * List of all behaviors that compound this one.
65
	 */
63 66
	private ArrayList mapTools = new ArrayList();
67

  
68
	/**
69
	 * List that determines which behaviors of this one will be real-time painted. 
70
	 */
64 71
	private ArrayList draws = new ArrayList();
65 72

  
73
	/**
74
 	 * <p>Creates a new behavior as a composition of others.</p>
75
 	 *
76
	 * @param tools atomic behaviors that will compound this one</code>
77
	 */
66 78
	public CompoundBehavior(Behavior[] tools){
67 79
		for (int i = 0; i < tools.length; i++) {
68 80
			mapTools.add(tools[i]);
......
72 84
				draws.add(Boolean.FALSE);
73 85
		}
74 86
	}
75
	
87

  
88
	/**
89
	 * <p>Adds a new behavior, setting if will be real-time (when user is working with it) drawn or not.</p>
90
	 * 
91
	 * <p>When user works with a compound behavior, he/she will see on real-time the graphical changes produced at
92
	 *  the associated <code>MapControl</code>, only by those which have their associated <i>draw</i> flag to <code>true</code>.</p>
93
	 * 
94
	 * @param mt the new behavior
95
	 * @param draw flag determining if will be real-time drawn or no
96
	 */
76 97
	public void addMapBehavior(Behavior mt, boolean draw){
77 98
		mapTools.add(mt);
78 99
		draws.add(new Boolean(draw));
79 100
	}
80
	
81
	/**
82
	 * DOCUMENT ME!
83
	 *
84
	 * @return DOCUMENT ME!
101

  
102
	/*
103
	 * (non-Javadoc)
104
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#getCursor()
85 105
	 */
86 106
	public Cursor getCursor() {
87 107
		if (mapTools.size() > 0) {
......
91 111
		}
92 112
	}
93 113

  
94
	/**
95
	 * DOCUMENT ME!
96
	 *
97
	 * @param e DOCUMENT ME!
98
	 *
99
	 * @throws BehaviorException DOCUMENT ME!
114
	/*
115
	 * (non-Javadoc)
116
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseClicked(java.awt.event.MouseEvent)
100 117
	 */
101 118
	public void mouseClicked(MouseEvent e) throws BehaviorException {
102 119
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
106 123
		}
107 124
	}
108 125

  
109
	/**
110
	 * DOCUMENT ME!
111
	 *
112
	 * @param e DOCUMENT ME!
113
	 *
114
	 * @throws BehaviorException DOCUMENT ME!
126
	/*
127
	 * (non-Javadoc)
128
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseDragged(java.awt.event.MouseEvent)
115 129
	 */
116 130
	public void mouseDragged(MouseEvent e) throws BehaviorException {
117 131
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
121 135
		}
122 136
	}
123 137

  
124
	/**
125
	 * DOCUMENT ME!
126
	 *
127
	 * @param e DOCUMENT ME!
128
	 *
129
	 * @throws BehaviorException DOCUMENT ME!
138
	/*
139
	 * (non-Javadoc)
140
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseEntered(java.awt.event.MouseEvent)
130 141
	 */
131 142
	public void mouseEntered(MouseEvent e) throws BehaviorException {
132 143
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
136 147
		}
137 148
	}
138 149

  
139
	/**
140
	 * DOCUMENT ME!
141
	 *
142
	 * @param e DOCUMENT ME!
143
	 *
144
	 * @throws BehaviorException DOCUMENT ME!
150
	/*
151
	 * (non-Javadoc)
152
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseExited(java.awt.event.MouseEvent)
145 153
	 */
146 154
	public void mouseExited(MouseEvent e) throws BehaviorException {
147 155
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
151 159
		}
152 160
	}
153 161
	
154
	/**
155
	 * DOCUMENT ME!
156
	 *
157
	 * @param e DOCUMENT ME!
158
	 *
159
	 * @throws BehaviorException DOCUMENT ME!
162
	/*
163
	 * (non-Javadoc)
164
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseMoved(java.awt.event.MouseEvent)
160 165
	 */
161 166
	public void mouseMoved(MouseEvent e) throws BehaviorException {
162 167
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
166 171
		}
167 172
	}
168 173

  
169
	/**
170
	 * DOCUMENT ME!
171
	 *
172
	 * @param e DOCUMENT ME!
173
	 *
174
	 * @throws BehaviorException DOCUMENT ME!
174
	/*
175
	 * (non-Javadoc)
176
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mousePressed(java.awt.event.MouseEvent)
175 177
	 */
176 178
	public void mousePressed(MouseEvent e) throws BehaviorException {
177 179
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
181 183
		}
182 184
	}
183 185

  
184
	/**
185
	 * DOCUMENT ME!
186
	 *
187
	 * @param e DOCUMENT ME!
188
	 *
189
	 * @throws BehaviorException DOCUMENT ME!
186
	/*
187
	 * (non-Javadoc)
188
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseReleased(java.awt.event.MouseEvent)
190 189
	 */
191 190
	public void mouseReleased(MouseEvent e) throws BehaviorException {
192 191
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
196 195
		}
197 196
	}
198 197

  
199
	/**
200
	 * DOCUMENT ME!
201
	 *
202
	 * @param e DOCUMENT ME!
203
	 *
204
	 * @throws BehaviorException DOCUMENT ME!
198
	/*
199
	 * (non-Javadoc)
200
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#mouseWheelMoved(java.awt.event.MouseWheelEvent)
205 201
	 */
206 202
	public void mouseWheelMoved(MouseWheelEvent e) throws BehaviorException {
207 203
		for (Iterator iter = mapTools.iterator(); iter.hasNext();) {
......
211 207
		}
212 208
	}
213 209

  
214
	/**
215
	 * DOCUMENT ME!
216
	 *
217
	 * @param g DOCUMENT ME!
210
	/*
211
	 * (non-Javadoc)
212
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#paintComponent(java.awt.Graphics)
218 213
	 */
219 214
	public void paintComponent(Graphics g) {
220 215
		for (int i = 0; i < mapTools.size(); i++) {
......
226 221
	}
227 222

  
228 223
	/**
229
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#setListener(com.iver.cit.gvsig.fmap.tools.Listeners.ToolListener)
224
	 * Sets a tool listener to work with a <code>MapControl</code> instance using these behaviors.
225
	 * 
226
	 * @param listener a <code>RectangleListener</code> object for this behavior
230 227
	 */
231 228
	public void setListener(ToolListener listener) {
232 229
		if (listener != null) {
......
235 232
		}
236 233
	}
237 234

  
238
	/**
235
	/*
236
	 * (non-Javadoc)
239 237
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#getListener()
240 238
	 */
241 239
	public ToolListener getListener() {
242 240
		return null;
243 241
	}
242

  
243
	/*
244
	 * (non-Javadoc)
245
	 * @see com.iver.cit.gvsig.fmap.tools.Behavior.Behavior#setMapControl(com.iver.cit.gvsig.fmap.MapControl)
246
	 */
244 247
	public void setMapControl(MapControl mc) {
245 248
		for (int i = 0; i < mapTools.size(); i++) {
246 249
			Behavior mapTool = (Behavior) mapTools.get(i);

Also available in: Unified diff