18. Capturando eventos: Listeners

Los listeners nos permiten responder a eventos que ocurren en el programa. Por ejemplo, tenemos el listener ViewPortListener que lanza un evento cada vez que modificamos la pantalla de nuestra Vista, por ejemplo, lanzará un evento cada vez que hagamos Zoom In o Zoom out.

Una forma de usar estos listeners es utilizando la herencia, creando una clase derivada de una o de varias anteriores.

Nota

Dejo el código de los ficheros .xml para la generación de la interfaz visual. En cada ejemplo indico los únicos componentes que necesitáis tener para que podáis crear el vuestro propio.

18.1. ViewPortListener

En el siguiente ejemplo vemos como creamos una clase nueva MonitorSuma que hereda de FormPanel y ViewPortListener. Lanzamos la aplicación en las líneas:

mapContext = currentView().getMapContext()
monitor = MonitorSuma(mapContext)
monitor.showTool("Monitor de Escala")

Vemos que al iniciar la clase añadimos nuestro objeto MonitorSuma al gestor de listener del ViewPort self.mapContext.getViewPort().addViewPortListener(self) y lo eliminamos al cerrar la aplicación self.mapContext.getViewPort().removeViewPortListener(self). De esta forma, cada vez que se modifica la extensión del mapContext, se lanza el método extentChange() en el cual tenemos puesto que actualice una caja de texto (txtScale) donde aparecerá la escala actual de la Vista.

Ejemplo:

# encoding: utf-8
from gvsig import *
from gvsig.commonsdialog import *

from org.gvsig.fmap.mapcontext.events.listeners import ViewPortListener
from gvsig.libs.formpanel import FormPanel
import os


class MonitorEscala(ViewPortListener, FormPanel):
        def __init__(self, mapContext):
                FormPanel.__init__(self, getResource(__file__,"monitor_escala.xml"))

                self.mapContext = mapContext

                #Iniciamos valores de etiquetas
                self.lblName.setText("Scale")
                self.txtScale.setText(self.getScale())

                # Agregamos listener al ViewPort
                self.mapContext.getViewPort().addViewPortListener(self)

        def btnCerrar_click(self,*args):
                # Eliminamos el listener
                self.mapContext.getViewPort().removeViewPortListener(self)
                self.hide()

        def getScale(self):
                scale = "1:"+ str(self.mapContext.getScaleView())
                return scale

        def changeScale(self):
                self.txtScale.setText(self.getScale())

        # Metodo obligatorio de ViewPortListener
        def backColorChanged(self,*args):
                pass

        # Metodo obligatorio de ViewPortListener
        def extentChanged(self,*args):
                self.changeScale()

        # Metodo obligatorio de ViewPortListener
        def projectionChanged(self,*args):
                pass


def main(*args):
        if currentView() == None:
                msgbox("Debera tener una vista abierta y activa")
                return

        mapContext = currentView().getMapContext()
        monitor = MonitorEscala(mapContext)
        monitor.showTool("Monitor de Escala")

Contenido del fichero .xml. Contiene una caja de texto txtScale, una etiqueta lblName y un botón Cerrar btnCerrar.

Descarga del script: MonitorEscala

Ejemplo Monitor: Consiste en un script que hace un sumatorio de cierto campo de las entidades que solo aparezcan visualmente en la Vista. Descarga del script: Monitor

18.2. PointListener

Otro ejemplo similar al anterior es este en el que capturamos los eventos lanzados desde el PointListener, que hace referencia a clicks que hacemos sobre la Vista activa. También tendremos que apoyarnos en PointBehavior para poder añadir este comportamiento al mapControl.

En el siguiente ejemplo, capturaremos las coordenadas del mapa en el punto que hacemos click o doble click con el ratón:

Código:

from gvsig import *

from org.gvsig.fmap import IconThemeHelper
from org.gvsig.fmap.mapcontrol.tools.Listeners import PointListener
from org.gvsig.fmap.mapcontrol.tools.Behavior import PointBehavior
from org.gvsig.app.project.documents.view import ViewManager

from gvsig.libs.formpanel import FormPanel
import os

class Coordenadas(FormPanel, PointListener):
    def __init__(self, viewdoc):
        FormPanel.__init__(self, getResource(__file__, "coordenadas.xml"))
        self.viewdoc = viewdoc
        self.mapControl = self.viewdoc.getWindowOfView().getMapControl()
        self.mapControl.addBehavior("TestGetXYPointTool", PointBehavior(self))
        self.mapControl.setTool("TestGetXYPointTool")

    def btnCerrar_click(self,*args):
        self.hide()

    def point(self, event):
        """Evento de PointListener"""
        p = event.getMapPoint()
        self.txtX.setText(str(p.getX()))
        self.txtY.setText(str(p.getY()))

    def pointDoubleClick(self, event):
        """Evento de PointListener"""
        p = event.getMapPoint()
        self.txtX.setText(str(p.getX()))
        self.txtY.setText(str(p.getY()))

    def getImageCursor(self):
        """Evento de PointListener"""
        return IconThemeHelper.getImage("cursor-select-by-point")

    def cancelDrawing(self):
        """Evento de PointListener"""
        return False

def main(*args):
    coordenadas = Coordenadas(currentView())
    coordenadas.showTool("Coordenadas")

La interfaz contiene los componentes importantes de: txtX y txtY para que funcione correctamente.

Descarga del script: Coordenadas

Notese que en este caso estamos utilizando el comportamiento de PointBehavior. Este comportamiento se ejecuta cuando hacemos un click sobre la Vista. Por ejemplo, otro tipo de comportamiento es el MouseMovementBehavior que se ejecutará a cada pixel que nos movamos por la Vista con el ratón sin necesidad de hacer click. Para adaptar el script anteroir habría que cambiar un par de lineas y el import:

from org.gvsig.fmap.mapcontrol.tools.Behavior import MouseMovementBehavior
....
    class Coordenadas(FormPanel, PointListener):
        def __init__(self, viewdoc):
            .....
            self.mapControl.addBehavior("TestGetXYPointTool", MouseMovementBehavior(self))
            .....

18.3. LayerListener & LayerCollectionListener

Ambos listeners correspondientes al mapcontext:

from org.gvsig.fmap.mapcontext.layers import LayerCollectionListener from org.gvsig.fmap.mapcontext.layers.operations import LayerCollection

Su función es la de capturar eventos correspondientes a las capas, tanto sueltas como en agrupaciones.

Un ejemplo de código en uso sería el siguiente (código sacado del plugin TabbedToC https://github.com/gvSIGAssociation/gvsig-desktop-scripting-TabbedToC ):

class UpdateToCListener(LayerListener,LayerCollectionListener):
  def __init__(self, id, callable):
    self.callable = callable
    self.id = id

  def getId(self):
    return self.id

  def fireEvent(self):
    try:
      self.callable()
    except Exception,ex:
      pass

  def layerAdded(self, e):
    layer = e.getAffectedLayer()
    if isinstance(layer,LayerCollection):
      layer.addLayerCollectionListener(self)
    self.fireEvent()

  def layerAdding(self, e):
    pass

  def layerMoved(self, e):
    self.fireEvent()

  def layerMoving(self, e):
    pass

  def layerRemoved(self, e):
    self.fireEvent()

  def layerRemoving(self, e):
    pass

  def visibilityChanged(self, e):
    self.fireEvent()

  def activationChanged(self,e):
    self.fireEvent()

  def drawValueChanged(self,e):
    self.fireEvent()

  def editionChanged(self,e):
    self.fireEvent()

  def nameChanged(self,e):
    self.fireEvent()


def addUpdateToCListener(id, mapContext, func):
  layers = mapContext.getLayers()
  if layers == None:
    return
  mylistener = UpdateToCListener(id,func)
  layersList = list()
  layersList.append(layers)
  layersList.extend(mapContext.deepiterator())
  for layer in layersList:
    listeners = layer.getLayerListeners()
    for listener in listeners:
      if isinstance(listener,UpdateToCListener) and listener.getId()==id:
        layer.removeLayerListener(listener)
    if isinstance(layer, LayerCollection):
      layer.addLayerCollectionListener(mylistener)
    layer.addLayerListener(mylistener)

En este ejemplo, la función addUpdateToCListener tiene como propósito agregar a cada capa que tiene el mapcontext un listener con un ID determinado, y una función determinada (fireEvent). La función comprueba si ya existe un listener con ese ID, en caso de que exista, elimina el listener anterior. El listener UpdateToCListener, clase que extiende de LayerListener y LayerCollectionListener, recibirá los eventos y ejecutará el método fireEvent, que sería una función que se le pasa a addUpdateToCListener como parámetro.