Package 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	Description
static final String	LABELINGSTRATEGY_FILE_EXTENSION
static final String	LEGEND_FILE_EXTENSION

Method Summary

Modifier and Type	Method	Description
IMultiLayerSymbol	createMultiLayerSymbol(int geomType)	Creates a new IMultiLayerSymbol which can be used to render the given Geometry type.
IMultiLayerSymbol	createMultiLayerSymbol(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, Color color)	Creates a new ISymbol which can be used to render the given Geometry type, with the given Color.
ISymbol	createSymbol(String symbolName)	Creates a new ISymbol.
ISymbol	createSymbol(String symbolName, Color color)	Creates a new ISymbol with the given Color.
ISymbol	getSymbol(String libraryName, String symbolID)
List	getSymbolLibraryNames()
SymbolPreferences	getSymbolPreferences()	Returns the current SymbolPreferences.
IWarningSymbol	getWarningSymbol(String message, String symbolDesc, int symbolDrawExceptionType)	Returns an instance of IWarningSymbol.
ISymbol	loadSymbol(File file)
ISymbol[]	loadSymbols(File folder)	Loads the symbols persisted into a folder.
ISymbol[]	loadSymbols(File folder, FileFilter filter)	Loads the symbols persisted into a folder.
org.gvsig.tools.task.CancellableTask	loadSymbols(File folder, FileFilter filter, org.gvsig.tools.visitor.Visitor visitor)
void	registerMultiLayerSymbol(String symbolName, int[] geomTypes, Class symbolClass)	Registers a IMultiLayerSymbol implementation class with a name and a list of geometry types which the symbol is able to render.
void	registerMultiLayerSymbol(String symbolName, Class symbolClass)	Registers a IMultiLayerSymbol implementation class with a name.
void	registerSymbol(String symbolName, int[] geomTypes, Class symbolClass)	Registers a ISymbol implementation class with a name and a list of geometry types which the symbol is able to render.
void	registerSymbol(String symbolName, Class symbolClass)	Registers a ISymbol implementation class with a name.
void	saveSymbol(ISymbol symbol, String fileName, File folder)	Persists a ISymbol into the given folder, with the given file name.
void	saveSymbol(ISymbol symbol, String fileName, File folder, boolean overwrite)	Persists a ISymbol into the given folder, with the given file name.
void	setSymbolPreferences(SymbolPreferences symbolPreferences)

Field Details

LEGEND_FILE_EXTENSION

static final String LEGEND_FILE_EXTENSION

See Also:

• Constant Field Values

LABELINGSTRATEGY_FILE_EXTENSION

static final String LABELINGSTRATEGY_FILE_EXTENSION

See Also:

• Constant Field Values

Method Details

loadSymbol

ISymbol loadSymbol(File file)
            throws SymbolException

Throws:

SymbolException

loadSymbols

ISymbol[] loadSymbols(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(File folder,
 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

loadSymbols

org.gvsig.tools.task.CancellableTask loadSymbols(File folder,
 FileFilter filter,
 org.gvsig.tools.visitor.Visitor visitor)

saveSymbol

void saveSymbol(ISymbol symbol,
 String fileName,
 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,
 String fileName,
 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

getSymbolPreferences

SymbolPreferences getSymbolPreferences()

Returns the current SymbolPreferences.

Returns:

the current SymbolPreferences

createSymbol

ISymbol createSymbol(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(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(String symbolName,
 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

createSymbol

ISymbol createSymbol(int geomType,
 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

createMultiLayerSymbol

IMultiLayerSymbol createMultiLayerSymbol(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

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

registerSymbol

void registerSymbol(String symbolName,
 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(String symbolName,
 int[] geomTypes,
 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

registerMultiLayerSymbol

void registerMultiLayerSymbol(String symbolName,
 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(String symbolName,
 int[] geomTypes,
 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

getWarningSymbol

IWarningSymbol getWarningSymbol(String message,
 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

setSymbolPreferences

void setSymbolPreferences(SymbolPreferences symbolPreferences)

getSymbolLibraryNames

List getSymbolLibraryNames()

getSymbol

ISymbol getSymbol(String libraryName,
 String symbolID)
           throws SymbolException

Throws:

SymbolException