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

View differences:

EventBuffer.java
56 56

  
57 57

  
58 58
/**
59
 * <p>The class <code>EventBuffer</code> represents a buffer of events that allows store listeners for the events, and
60
 *  configure its dispatching.</p>
59
 * <p><code>EventBuffer</code> represents a buffer of events that allows store listeners of events produced in layers
60
 *  of a <code>MapContext</code> instance, and configure its dispatching mode.</p>
61 61
 * 
62
 * <p>The <i>dispatching mode:</i>
62
 * <p>The <i>dispatching mode</i>:
63 63
 * <ul>
64
 *  <li>If <code>true</code> : dispatches each new event received.
65
 *  <li>If <code>false</code> : accumulates all new events received in a internal buffer, and only will dispatch them
66
 *   (according to the order they were received) when changes the mode.
64
 *  <li><code>true</code> : dispatches each new event received.</li>
65
 *  <li><code>false</code> : accumulates all new events received in a internal buffer, and only will dispatch them
66
 *   (according to the order they were received) when changes the mode.</li>
67 67
 * </ul>
68 68
 * </p>
69 69
 *
......
119 119
	private boolean dispatching = true;
120 120

  
121 121
	/**
122
	 * Enables buffer in <i>accumulation event</i> mode. And then, all new events received, will be accumulated and
123
	 * don't notified to their respective listeners, until this buffer receive a call to {@link #endAtomicEvent() endAtomicEvent}.
122
	 * <p>Enables buffer in <i>accumulation event</i> mode.<p>
124 123
	 * 
124
	 * <p>All new events received, will be accumulated and won't notified to their respective listeners,
125
	 *  until this buffer would received a call to {@link #endAtomicEvent() endAtomicEvent}.</p>
126
	 * 
125 127
	 * @see #endAtomicEvent()
126 128
	 */
127 129
	public void beginAtomicEvent() {
......
129 131
	}
130 132

  
131 133
	/**
132
	 * Disables buffer in <i>accumulation event</i> mode. And then, all events accumulated will be notify to their respective
133
	 *  listeners, in the same order as they arrived.
134
	 * <p>Disables buffer in <i>accumulation event</i> mode.</p>
135
	 * 
136
	 * <p>All events accumulated will be notify to their respective
137
	 *  listeners, in the same order as they arrived.</p>
134 138
	 *  
135 139
	 * @see #beginAtomicEvent()
136 140
	 */
......
253 257
	}
254 258

  
255 259
	/**
256
	 * Appends, if it wasn't, the specified listener to the end of the internal list of atomic event listeners.
260
	 * Appends, if wasn't, the specified listener to the end of the internal list of atomic event listeners.
257 261
	 *
258 262
	 * @param listener an object that implements the atomic event listener
259 263
	 *
260
	 * @return <code>true</code> if has added the listener successfully
264
	 * @return <code>true</code> if has added the listener successfully; otherwise <code>false</code>
261 265
	 * 
262 266
	 * @see #removeAtomicEventListener(AtomicEventListener)
263 267
	 * @see #fireAtomicEventListener()

Also available in: Unified diff