org.gvsig.fmap.mapcontext.rendering.symbols

Interface SymbolManager

All Known Implementing Classes:

DefaultSymbolManager

public interface SymbolManager

Symbols management: creation, registration, etc.

Author:

gvSIG team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LABELINGSTRATEGY_FILE_EXTENSION
static java.lang.String	LEGEND_FILE_EXTENSION

Method Summary

Methods

Modifier and Type	Method and Description
IMultiLayerSymbol	createMultiLayerSymbol(int geomType) Creates a new IMultiLayerSymbol which can be used to render the given Geometry type.
IMultiLayerSymbol	createMultiLayerSymbol(java.lang.String symbolName) Creates a new IMultiLayerSymbol.
ISymbol	createSymbol(int geomType) Creates a new ISymbol which can be used to render the given Geometry type.
ISymbol	createSymbol(int geomType, java.awt.Color color) Creates a new ISymbol which can be used to render the given Geometry type, with the given Color.
ISymbol	createSymbol(java.lang.String symbolName) Creates a new ISymbol.
ISymbol	createSymbol(java.lang.String symbolName, java.awt.Color color) Creates a new ISymbol with the given Color.
SymbolPreferences	getSymbolPreferences() Returns the current SymbolPreferences.
IWarningSymbol	getWarningSymbol(java.lang.String message, java.lang.String symbolDesc, int symbolDrawExceptionType) Returns an instance of IWarningSymbol.
ISymbol[]	loadSymbols(java.io.File folder) Loads the symbols persisted into a folder.
ISymbol[]	loadSymbols(java.io.File folder, java.io.FileFilter filter) Loads the symbols persisted into a folder.
void	registerMultiLayerSymbol(java.lang.String symbolName, java.lang.Class symbolClass) Registers a IMultiLayerSymbol implementation class with a name.
void	registerMultiLayerSymbol(java.lang.String symbolName, int[] geomTypes, java.lang.Class symbolClass) Registers a IMultiLayerSymbol implementation class with a name and a list of geometry types which the symbol is able to render.
void	registerSymbol(java.lang.String symbolName, java.lang.Class symbolClass) Registers a ISymbol implementation class with a name.
void	registerSymbol(java.lang.String symbolName, int[] geomTypes, java.lang.Class symbolClass) Registers a ISymbol implementation class with a name and a list of geometry types which the symbol is able to render.
void	saveSymbol(ISymbol symbol, java.lang.String fileName, java.io.File folder) Persists a ISymbol into the given folder, with the given file name.
void	saveSymbol(ISymbol symbol, java.lang.String fileName, java.io.File folder, boolean overwrite) Persists a ISymbol into the given folder, with the given file name.
void	setSymbolPreferences(SymbolPreferences symbolPreferences)

Field Detail

LABELINGSTRATEGY_FILE_EXTENSION

static final java.lang.String LABELINGSTRATEGY_FILE_EXTENSION

See Also:

Constant Field Values

LEGEND_FILE_EXTENSION

static final java.lang.String LEGEND_FILE_EXTENSION

See Also:

Constant Field Values

Method Detail

createMultiLayerSymbol

IMultiLayerSymbol createMultiLayerSymbol(int geomType)
                                         throws MapContextRuntimeException

Creates a new IMultiLayerSymbol which can be used to render the given Geometry type.

Parameters:

geomType - the Geometry type to render

Returns:

a new IMultiLayerSymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createMultiLayerSymbol

IMultiLayerSymbol createMultiLayerSymbol(java.lang.String symbolName)
                                         throws MapContextRuntimeException

Creates a new IMultiLayerSymbol.

Parameters:

symbolName - the name of the symbol to create

Returns:

a new IMultiLayerSymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createSymbol

ISymbol createSymbol(int geomType)
                     throws MapContextRuntimeException

Creates a new ISymbol which can be used to render the given Geometry type.

Parameters:

geomType - the Geometry type to render

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createSymbol

ISymbol createSymbol(int geomType,
                   java.awt.Color color)
                     throws MapContextRuntimeException

Creates a new ISymbol which can be used to render the given Geometry type, with the given Color.

Parameters:

geomType - the Geometry type to render

color - the color for the symbol

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createSymbol

ISymbol createSymbol(java.lang.String symbolName)
                     throws MapContextRuntimeException

Creates a new ISymbol.

Parameters:

symbolName - the name of the symbol to create

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

createSymbol

ISymbol createSymbol(java.lang.String symbolName,
                   java.awt.Color color)
                     throws MapContextRuntimeException

Creates a new ISymbol with the given Color.

Parameters:

symbolName - the name of the symbol to create

color - the color for the symbol

Returns:

a new ISymbol

Throws:

MapContextRuntimeException - if there is an error creating the symbol

getSymbolPreferences

SymbolPreferences getSymbolPreferences()

Returns the current SymbolPreferences.

Returns:

the current SymbolPreferences

getWarningSymbol

IWarningSymbol getWarningSymbol(java.lang.String message,
                              java.lang.String symbolDesc,
                              int symbolDrawExceptionType)
                                throws MapContextRuntimeException

Returns an instance of IWarningSymbol. TODO: revisar el uso de esto, a ver si es necesario o se puede ocultar dentro de la implementación.

Parameters:

message -

symbolDesc -

symbolDrawExceptionType -

Returns:

the warning symbol

Throws:

MapContextRuntimeException

loadSymbols

ISymbol[] loadSymbols(java.io.File folder)
                      throws SymbolException

Loads the symbols persisted into a folder. It loads the symbols through the use of the current PersistenceManager, loading all files found into the folder.

Parameters:

folder - to load the persisted symbols from

Returns:

the list of loaded symbols

Throws:

SymbolException - if there is an error loading the symbols

loadSymbols

ISymbol[] loadSymbols(java.io.File folder,
                    java.io.FileFilter filter)
                      throws SymbolException

Loads the symbols persisted into a folder. It loads the symbols through the use of the current PersistenceManager, loading the files found into the folder which apply to the provided filter.

Parameters:

folder - to load the persisted symbols from

filter - to apply to know which files to load

Returns:

the list of loaded symbols

Throws:

SymbolException - if there is an error loading the symbols

registerMultiLayerSymbol

void registerMultiLayerSymbol(java.lang.String symbolName,
                            java.lang.Class symbolClass)
                              throws MapContextRuntimeException

Registers a IMultiLayerSymbol implementation class with a name. This way the symbol class is not related to any geometry type, so it can be created only through the createMultiLayerSymbol(String) method.

Parameters:

symbolName - the symbol name

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the IMultiLayerSymbol interface

registerMultiLayerSymbol

void registerMultiLayerSymbol(java.lang.String symbolName,
                            int[] geomTypes,
                            java.lang.Class symbolClass)
                              throws MapContextRuntimeException

Registers a IMultiLayerSymbol implementation class with a name and a list of geometry types which the symbol is able to render.

Parameters:

symbolName - the symbol name

geomTypes - the list of geometry types the symbol is able to render

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the IMultiLayerSymbol interface

registerSymbol

void registerSymbol(java.lang.String symbolName,
                  java.lang.Class symbolClass)
                    throws MapContextRuntimeException

Registers a ISymbol implementation class with a name. This way the symbol class is not related to any geometry type, so it can be created only through the createSymbol(String) method.

Parameters:

symbolName - the symbol name

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the ISymbol interface

registerSymbol

void registerSymbol(java.lang.String symbolName,
                  int[] geomTypes,
                  java.lang.Class symbolClass)
                    throws MapContextException

Registers a ISymbol implementation class with a name and a list of geometry types which the symbol is able to render.

Parameters:

symbolName - the symbol name

geomTypes - the list of geometry types the symbol is able to render

symbolClass - the symbol implementation class

Throws:

MapContextRuntimeException - if the provided class does not implement the ISymbol interface

MapContextException

saveSymbol

void saveSymbol(ISymbol symbol,
              java.lang.String fileName,
              java.io.File folder)
                throws SymbolException

Persists a ISymbol into the given folder, with the given file name.

Parameters:

symbol - to persist

fileName - of the file to create

folder - where to create the file

Throws:

SymbolException - if there is an error persisting the symbol, or the file to create already exists

saveSymbol

void saveSymbol(ISymbol symbol,
              java.lang.String fileName,
              java.io.File folder,
              boolean overwrite)
                throws SymbolException

Persists a ISymbol into the given folder, with the given file name.

Parameters:

symbol - to persist

fileName - of the file to create

folder - where to create the file

overwrite - what to do if the file to create already exists

Throws:

SymbolException - if there is an error persisting the symbol, or the file to create already exists and overwrite is false

setSymbolPreferences

void setSymbolPreferences(SymbolPreferences symbolPreferences)