com.iver.cit.gvsig.fmap.rendering
Interface VectorialLegend

All Superinterfaces:

Legend

All Known Implementing Classes:

SingleSymbolLegend, VectorialIntervalLegend, VectorialUniqueValueLegend

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.
XMLEntity	getXMLEntity() Devuelve el XMLEntity.
void	setDataSource(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	setShapeType(int shapeType) Inserta el tipo de shape.
void	setXMLEntity(XMLEntity xml) Inserta el XMLEntity.

Methods inherited from interface com.iver.cit.gvsig.fmap.rendering.Legend

cloneLegend, getDefaultSymbol

Method Detail

setDataSource

public void setDataSource(DataSource ds)
                   throws FieldNotFoundException,
                          DriverException

Inserta el DataSource.

Parameters:

ds - DataSource.

Throws:

FieldNotFoundException - cuando el campo no se encuentre.

DriverException - Cuando falle el driver.

getSymbol

public FSymbol getSymbol(int recordIndex)
                  throws DriverException

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:

DriverException

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.

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.

getXMLEntity

public XMLEntity getXMLEntity()

Devuelve el XMLEntity.

Specified by:

getXMLEntity in interface Legend

Returns:

XMLEntity.

setXMLEntity

public void setXMLEntity(XMLEntity xml)

Inserta el XMLEntity.

Parameters:

xml - XMLEntity.