es.prodevelop.gvsig.mobile.fmap.legend
Interface VectorialLegend

All Superinterfaces:
Legend
All Known Implementing Classes:
SingleSymbolLegend

public interface VectorialLegend
extends Legend

Interfaz de Leyenda Vectorial.

Author:
Vicente Caballero Navarro

Method Summary
 java.lang.String getLabelField()
          Obtiene el índice del campo que sirve de etiquetado o -1 si no ha sido etiquetado
 java.lang.String getLabelHeightField()
          Devuelve el alto de campo.
 java.lang.String getLabelRotationField()
          Devuelve la rotación.
 int getShapeType()
          Devuelve el tipo de shape.
 FSymbol getSymbol(int recordIndex)
          Devuelve el símbolo asociado al objeto que se pasa como parámetro.
 FSymbol getSymbolByFeature(IFeature feat)
           
 java.lang.String[] getUsedFields()
          Se usa para saber antes de dibujar, los campos que vamos a necesitar leer, y leer solo estos.
 void setDataSource(com.hardcode.gdbms.engine.data.DataSource ds)
          Inserta el DataSource.
 void setDefaultSymbol(FSymbol s)
          Establece el símbolo por defecto del Legend.
 void setLabelField(java.lang.String fieldName)
          Establece el campo por el que se etiqueta. -1 quita el etiquetado
 void setLabelHeightField(java.lang.String fieldName)
           
 void setLabelRotationField(java.lang.String fieldName)
           
 void setShapeType(int shapeType)
          Inserta el tipo de shape.
 void useDefaultSymbol(boolean b)
           
 
Methods inherited from interface es.prodevelop.gvsig.mobile.fmap.legend.Legend
getDefaultSymbol
 

Method Detail

setDataSource

public void setDataSource(com.hardcode.gdbms.engine.data.DataSource ds)
                   throws com.hardcode.gdbms.engine.instruction.FieldNotFoundException,
                          FMapDriverException
Inserta el DataSource.

Parameters:
ds - DataSource.
Throws:
com.hardcode.gdbms.engine.instruction.FieldNotFoundException - cuando el campo no se encuentre.
FMapDriverException - Cuando falle el driver.

getSymbol

public FSymbol getSymbol(int recordIndex)
                  throws FMapDriverException
Devuelve el símbolo asociado al objeto que se pasa como parámetro. Si se pasa null se devuelve el símbolo por defecto. En un Legend de símbolo único siempre se devuelve dicho símbolo

Parameters:
recordIndex - índice
Returns:
Símbolo.
Throws:
FMapDriverException

getSymbolByFeature

public FSymbol getSymbolByFeature(IFeature feat)

getShapeType

public int getShapeType()
Devuelve el tipo de shape.

Returns:
Devuelve el tipo de shapes para los que está preparada la leyenda

setShapeType

public void setShapeType(int shapeType)
Inserta el tipo de shape.

Parameters:
shapeType - Tipo de shape.

setDefaultSymbol

public void setDefaultSymbol(FSymbol s)
Establece el símbolo por defecto del Legend. En un Legend de símbolo único, el símbolo se establece invocando este método

Parameters:
s - Símbolo por defecto.

setLabelField

public void setLabelField(java.lang.String fieldName)
Establece el campo por el que se etiqueta. -1 quita el etiquetado

Parameters:
fieldName - Nombre del campo.

setLabelHeightField

public void setLabelHeightField(java.lang.String fieldName)
Parameters:
fieldName -

setLabelRotationField

public void setLabelRotationField(java.lang.String fieldName)
Parameters:
fieldName -

getLabelField

public java.lang.String getLabelField()
Obtiene el índice del campo que sirve de etiquetado o -1 si no ha sido etiquetado

Returns:
nombre del campo.

getLabelHeightField

public java.lang.String getLabelHeightField()
Devuelve el alto de campo.

Returns:
alto.

getLabelRotationField

public java.lang.String getLabelRotationField()
Devuelve la rotación.

Returns:
Rotación.

useDefaultSymbol

public void useDefaultSymbol(boolean b)

getUsedFields

public java.lang.String[] getUsedFields()
Se usa para saber antes de dibujar, los campos que vamos a necesitar leer, y leer solo estos. Acelera el dibujado bastante, sobre todo en bases de datos espaciales.

Returns:
el array con los nombres de los campos usados. (Por ejemplo para el etiquetado, el campo de clasificación, etc)