es.prodevelop.gvsig.mobile.fmap.layer
Interface FLayer

All Known Implementing Classes:
FLyrDefault

public interface FLayer

Interfaz que tienen que implementar todas las capas.


Method Summary
 void addError(FMapDriverException error)
          add an error cause to describe the layer's wrong status
 boolean addLayerListener(LayerListener o)
          Añade un listener LayerListener a la lista de listeners.
 void clean()
           
 void draw(java.awt.Graphics2D g, ViewPort viewPort)
          Dibuja la capa
 ICoordTrans getCoordTrans()
          Devuelve las coordenadas de transformación.
 FMapDriverException getError(int i)
          return the specified error
 java.util.List getErrors()
          Returns a list with all layer errors
 java.awt.geom.Rectangle2D getFullExtent()
          Obtiene la extensión completa de la capa
 long getId()
           
 java.lang.String getInfoString()
          Devuelve una cadena con informacion sobre la capa.
 LayerListener[] getLayerListeners()
           
 MapContext getMapContext()
          Devuelve el FMap al que está añadida la capa o null si la capa no ha sido añadida a ningún FMap
 double getMaxScale()
          La capa no se visualiza si está por encima de esa escala
 java.lang.String getMemo()
           
 double getMinScale()
          La capa no se visualiza si está por debajo de esa escala
 java.lang.String getName()
          Devuelve el nombre de la capa.
 int getNumErrors()
          returns the number of errors that causes layer unavailable status
 java.lang.Object getProperty(java.lang.Object key)
          Useful to associate any object to a layer.
 boolean isActive()
          Devuelve true si la capa esta activa.
 boolean isAvailable()
           
 boolean isDirty()
           
 boolean isInfoable()
           
 boolean isInTOC()
          If the layer appears in the TOC then true is returned, if false the layer will not be displayed at the TOC although it remains in the view and in the project
 boolean isOk()
          Return if the layer is in OK status (it hasnt got errors)
 boolean isVisible()
          Devuelve true si la capa es visible.
 boolean isWithinScale(double scale)
           
 boolean isWritable()
           
 void load()
          Realiza las operaciones de inicialización de la capa.
 void reload()
          Intenta recuperar una capa ante un posible error.
 boolean removeLayerListener(LayerListener o)
          Borra de la lista el LayerListener que se pasa como parámetro.
 void setActive(boolean selected)
          Pone la capa actual a activa o inactiva según el boolean que se pasa como parámetro.
 void setAvailable(boolean available)
           
 void setCoordTrans(ICoordTrans ct)
          Inserta las coordenadas de transformación.
 void setDirty(boolean dirty)
          true if this layer need a repaint.
 void setInfoable(boolean info)
           
 void setMapContext(MapContext m)
           
 void setMaxScale(double maxScale)
           
 void setMemo(java.lang.String memo)
           
 void setMinScale(double minScale)
           
 void setName(java.lang.String name)
          Inserta un nombre a la capa.
 void setProperty(java.lang.Object key, java.lang.Object obj)
           
 void setVisible(boolean visibility)
          Pone la capa en modo visible o no visible.
 java.lang.StringBuffer toXML(java.lang.String name, java.lang.String proyectPath)
           
 boolean visibleRequired()
          Devuelve true si la capa esta establecida como visible.
 void wakeUp(boolean driver_is_already_open)
           
 

Method Detail

setActive

public void setActive(boolean selected)
Pone la capa actual a activa o inactiva según el boolean que se pasa como parámetro.

Parameters:
selected - activa.

isActive

public boolean isActive()
Devuelve true si la capa esta activa.

Returns:
activa.

setName

public void setName(java.lang.String name)
Inserta un nombre a la capa.

Parameters:
name - nombre.

getName

public java.lang.String getName()
Devuelve el nombre de la capa.

Returns:
nombre de la capa.

setMemo

public void setMemo(java.lang.String memo)

getMemo

public java.lang.String getMemo()

load

public void load()
          throws FMapDriverException
Realiza las operaciones de inicialización de la capa. El método es invocado una única vez durante la vida de la capa y justo antes de visualizar la capa

Throws:
DriverIOException
FMapDriverException

setVisible

public void setVisible(boolean visibility)
Pone la capa en modo visible o no visible.

Parameters:
visibility - visibilidad.

setInfoable

public void setInfoable(boolean info)

getId

public long getId()

isVisible

public boolean isVisible()
Devuelve true si la capa es visible. Es dependiente isAvialable @link isAvialable

Returns:
visibilidad.
See Also:
isAvialable(), setAvialable(), visibleRequired()

isInfoable

public boolean isInfoable()

getMapContext

public MapContext getMapContext()
Devuelve el FMap al que está añadida la capa o null si la capa no ha sido añadida a ningún FMap

Returns:
FMap

setMapContext

public void setMapContext(MapContext m)

getFullExtent

public java.awt.geom.Rectangle2D getFullExtent()
                                        throws FMapDriverException
Obtiene la extensión completa de la capa

Returns:
FullExtent.
Throws:
FMapDriverException

draw

public void draw(java.awt.Graphics2D g,
                 ViewPort viewPort)
          throws FMapDriverException
Dibuja la capa

Parameters:
g - Graphics2D sobre el que dibujar.
viewPort - Propiedades de la vista.
Throws:
FMapDriverException

setCoordTrans

public void setCoordTrans(ICoordTrans ct)
Inserta las coordenadas de transformación.

Parameters:
ct - Coordenadas de transformación.

getCoordTrans

public ICoordTrans getCoordTrans()
Devuelve las coordenadas de transformación.

Returns:
Coordenadas de transformación.

addLayerListener

public boolean addLayerListener(LayerListener o)
Añade un listener LayerListener a la lista de listeners.

Parameters:
o - Listener.
Returns:
True si es correcta la inserción del listener.

getLayerListeners

public LayerListener[] getLayerListeners()

removeLayerListener

public boolean removeLayerListener(LayerListener o)
Borra de la lista el LayerListener que se pasa como parámetro.

Parameters:
o - Listener.
Returns:
True si es correcto el borrado del listener.

isWithinScale

public boolean isWithinScale(double scale)

getMinScale

public double getMinScale()
La capa no se visualiza si está por debajo de esa escala

Returns:
la escala minima de visualización

getMaxScale

public double getMaxScale()
La capa no se visualiza si está por encima de esa escala

Returns:
la escala máxima de visualización

setMinScale

public void setMinScale(double minScale)

setMaxScale

public void setMaxScale(double maxScale)

isInTOC

public boolean isInTOC()
If the layer appears in the TOC then true is returned, if false the layer will not be displayed at the TOC although it remains in the view and in the project


isDirty

public boolean isDirty()
Returns:
true if this layer need a repaint.

setDirty

public void setDirty(boolean dirty)
true if this layer need a repaint. By default, all layers will be set to dirty when the extent changes. But for events like changing its legend, or editing a layer, we can perform some optimization in the method prepareDrawing from FMap.

Parameters:
dirty -

isOk

public boolean isOk()
Return if the layer is in OK status (it hasnt got errors)


getNumErrors

public int getNumErrors()
returns the number of errors that causes layer unavailable status

Returns:

getError

public FMapDriverException getError(int i)
return the specified error

Parameters:
i -
Returns:

addError

public void addError(FMapDriverException error)
add an error cause to describe the layer's wrong status

Parameters:
error -

getErrors

public java.util.List getErrors()
Returns a list with all layer errors

Returns:

setAvailable

public void setAvailable(boolean available)
Returns:
set layer aviable or not.

isAvailable

public boolean isAvailable()
Returns:
true if this layer is aviable. Default value is true.

reload

public void reload()
            throws FMapDriverException
Intenta recuperar una capa ante un posible error. Si tiene algun problema en la carga, marca el avialable a false y lanza una excepcion.

Throws:
DriverIOException
FMapDriverException

visibleRequired

public boolean visibleRequired()
Devuelve true si la capa esta establecida como visible.

Returns:
visibilidad.

getInfoString

public java.lang.String getInfoString()
Devuelve una cadena con informacion sobre la capa.

Returns:
visibilidad.

isWritable

public boolean isWritable()
Returns:
true if this layer can be put in edition mode and save the edits in itself.

getProperty

public java.lang.Object getProperty(java.lang.Object key)
Useful to associate any object to a layer. For example, you can attach a network definition to key "network" and check if a layer has a network loaded if getAssociatedObject("network") is not null

Parameters:
key -
Returns:
null if key is not found

setProperty

public void setProperty(java.lang.Object key,
                        java.lang.Object obj)
Parameters:
key -
obj -

wakeUp

public void wakeUp(boolean driver_is_already_open)

toXML

public java.lang.StringBuffer toXML(java.lang.String name,
                                    java.lang.String proyectPath)

clean

public void clean()