Package org.gvsig.fmap.mapcontext.events.listeners

Class EventBuffer

java.lang.Object

org.gvsig.fmap.mapcontext.events.listeners.EventBuffer

All Implemented Interfaces:

ViewPortListener, ViewPortListenerEx1, LayerCollectionListener, LayerListener, SelectionListener, LegendListener

public class EventBuffer
extends Object
implements LegendListener, LayerCollectionListener, SelectionListener, ViewPortListenerEx1, LayerListener

EventBuffer represents a buffer of events that allows store listeners of events produced in layers of a MapContext instance, and configure its dispatching mode. The dispatching mode:

• true : dispatches each new event received.
• false : accumulates all new events received in a internal buffer, and only will dispatch them (according to the order they were received) when changes the mode.

Author:

gvSIG Team

See Also:

• LegendListener
• LayerCollectionListener
• SelectionListener
• ViewPortListener
• LegendListener

Constructor Summary

Constructors

Constructor	Description
EventBuffer()

Method Summary

Modifier and Type	Method	Description
void	activationChanged(LayerEvent e)	Called when the activation of a layer has changed.
boolean	addAtomicEventListener(AtomicEventListener listener)	Appends, if wasn't, the specified listener to the end of the internal list of atomic event listeners.
void	backColorChanged(ColorEvent e)	Called when the background color of the view port has changed.
void	beginAtomicEvent()	Enables buffer in accumulation event mode.
void	drawValueChanged(LayerEvent e)	Called when a draw value of a layer has changed.
void	editionChanged(LayerEvent e)	Called when the edition of a layer has changed.
void	endAtomicEvent()	Disables buffer in accumulation event mode.
void	extentChanged(ExtentEvent e)	Called when the extent of the view port has changed.
List<AtomicEventListener>	getAtomicEventListeners()
void	layerAdded(LayerCollectionEvent e)	Called when a layer has been added or replaced in the internal list of layers.
void	layerAdding(LayerCollectionEvent e)	Called when a layer is just going to be added or replaced in the internal list of layers.
void	layerMoved(LayerPositionEvent e)	Called when a layer has been moved in the internal list of layers.
void	layerMoving(LayerPositionEvent e)	Called when a layer is just going to be moved in the internal list of layers.
void	layerRemoved(LayerCollectionEvent e)	Called when a layer has been removed from the internal list of layers.
void	layerRemoving(LayerCollectionEvent e)	Called when a layer is just going to be removed from the internal list of layers.
void	legendChanged(LegendChangedEvent e)	Called when the legend of a vector layer has changed.
void	nameChanged(LayerEvent e)	Called when the name of a layer has changed.
void	projectionChanged(ProjectionEvent e)	Called when the projection of the view port has changed.
boolean	removeAtomicEventListener(AtomicEventListener listener)	Removes a single instance of the AtomicEventListener from the internal list, if it is present (optional operation).Returns true if the list contained the specified element (or equivalently, if the list changed as a result of the call) .
void	selectionChanged(SelectionEvent e)	Called when the selection in a vector layer has changed.
void	selectionColorChanged(ColorEvent e)	Called when the selection color of the view port has changed.
void	visibilityChanged(LayerCollectionEvent e)	Called when the visibility of the collection of layers has changed.
void	visibilityChanged(LayerEvent e)	Called when the visibility of a layer has changed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EventBuffer

public EventBuffer()

Method Details

beginAtomicEvent

public void beginAtomicEvent()

Enables buffer in accumulation event mode. All new events received, will be accumulated and won't notified to their respective listeners, until this buffer would received a call to endAtomicEvent.

See Also:

• endAtomicEvent()

endAtomicEvent

public void endAtomicEvent()

Disables buffer in accumulation event mode. All events accumulated will be notify to their respective listeners, in the same order as they arrived.

See Also:

• beginAtomicEvent()

legendChanged

public void legendChanged(LegendChangedEvent e)

Description copied from interface: LegendListener

Called when the legend of a vector layer has changed.

Specified by:

legendChanged in interface LegendListener

Parameters:

e - the LegendChangedEvent contains contextual information about the event

layerAdded

public void layerAdded(LayerCollectionEvent e)

Description copied from interface: LayerCollectionListener

Called when a layer has been added or replaced in the internal list of layers.

Specified by:

layerAdded in interface LayerCollectionListener

Parameters:

e - a layer collection event object

layerMoved

public void layerMoved(LayerPositionEvent e)

Description copied from interface: LayerCollectionListener

Called when a layer has been moved in the internal list of layers.

Specified by:

layerMoved in interface LayerCollectionListener

Parameters:

e - a layer collection event object

layerRemoved

public void layerRemoved(LayerCollectionEvent e)

Description copied from interface: LayerCollectionListener

Called when a layer has been removed from the internal list of layers.

Specified by:

layerRemoved in interface LayerCollectionListener

Parameters:

e - a layer collection event object

layerAdding

public void layerAdding(LayerCollectionEvent e)
                 throws CancelationException

Description copied from interface: LayerCollectionListener

Called when a layer is just going to be added or replaced in the internal list of layers.

Specified by:

layerAdding in interface LayerCollectionListener

Parameters:

e - a layer collection event object

Throws:

CancelationException - if cancels the adding operation, this exception will have the message that user will see.

layerMoving

public void layerMoving(LayerPositionEvent e)
                 throws CancelationException

Description copied from interface: LayerCollectionListener

Called when a layer is just going to be moved in the internal list of layers.

Specified by:

layerMoving in interface LayerCollectionListener

Parameters:

e - a layer collection event object

Throws:

CancelationException - if cancels the moving operation, this exception will have the message that user will see.

layerRemoving

public void layerRemoving(LayerCollectionEvent e)
                   throws CancelationException

Description copied from interface: LayerCollectionListener

Called when a layer is just going to be removed from the internal list of layers.

Specified by:

layerRemoving in interface LayerCollectionListener

Parameters:

e - a layer collection event object

Throws:

CancelationException - if cancels the removing operation, this exception will have the message that user will see.

visibilityChanged

public void visibilityChanged(LayerCollectionEvent e)
                       throws CancelationException

Description copied from interface: LayerCollectionListener

Called when the visibility of the collection of layers has changed.

Specified by:

visibilityChanged in interface LayerCollectionListener

Parameters:

e - a layer collection event object

Throws:

CancelationException - if cancels the operation of change visibility, this exception will have the message that user will see.

selectionChanged

public void selectionChanged(SelectionEvent e)

Description copied from interface: SelectionListener

Called when the selection in a vector layer has changed.

The SelectionEvent event must be launched invoking the fireSelectionEvents method of the layer.

Specified by:

selectionChanged in interface SelectionListener

Parameters:

e - a selection event on a vector layer

extentChanged

public void extentChanged(ExtentEvent e)

Description copied from interface: ViewPortListener

Called when the extent of the view port has changed.

Specified by:

extentChanged in interface ViewPortListener

Parameters:

e - an extend event object

addAtomicEventListener

public boolean addAtomicEventListener(AtomicEventListener listener)

Appends, if wasn't, the specified listener to the end of the internal list of atomic event listeners.

Parameters:

listener - an object that implements the atomic event listener

Returns:

true if has added the listener successfully; otherwise false

See Also:

• removeAtomicEventListener(AtomicEventListener)
• fireAtomicEventListener()

getAtomicEventListeners

public List<AtomicEventListener> getAtomicEventListeners()

removeAtomicEventListener

public boolean removeAtomicEventListener(AtomicEventListener listener)

Removes a single instance of the AtomicEventListener from the internal list, if it is present (optional operation).Returns true if the list contained the specified element (or equivalently, if the list changed as a result of the call) .

Parameters:

listener - , element to be removed from this list, if present

Returns:

true if the list contained the specified element

See Also:

• addAtomicEventListener(AtomicEventListener)
• fireAtomicEventListener()

visibilityChanged

public void visibilityChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the visibility of a layer has changed.

Specified by:

visibilityChanged in interface LayerListener

Parameters:

e - a visibility changed layer event object

activationChanged

public void activationChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the activation of a layer has changed.

Specified by:

activationChanged in interface LayerListener

Parameters:

e - an activation changed layer event object

nameChanged

public void nameChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the name of a layer has changed.

Specified by:

nameChanged in interface LayerListener

Parameters:

e - a name changed layer event object

backColorChanged

public void backColorChanged(ColorEvent e)

Description copied from interface: ViewPortListener

Called when the background color of the view port has changed.

Specified by:

backColorChanged in interface ViewPortListener

Parameters:

e - a color event object

selectionColorChanged

public void selectionColorChanged(ColorEvent e)

Description copied from interface: ViewPortListenerEx1

Called when the selection color of the view port has changed.

Specified by:

selectionColorChanged in interface ViewPortListenerEx1

Parameters:

e - a color event object

editionChanged

public void editionChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the edition of a layer has changed.

Specified by:

editionChanged in interface LayerListener

Parameters:

e - an edition changed layer event object

projectionChanged

public void projectionChanged(ProjectionEvent e)

Description copied from interface: ViewPortListener

Called when the projection of the view port has changed.

Specified by:

projectionChanged in interface ViewPortListener

Parameters:

e - a projection event object

drawValueChanged

public void drawValueChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when a draw value of a layer has changed.

Specified by:

drawValueChanged in interface LayerListener

Parameters:

e - an edition changed layer event object