public interface SymbolManager
Modifier and Type | Field and Description |
---|---|
static String |
LABELINGSTRATEGY_FILE_EXTENSION |
static String |
LEGEND_FILE_EXTENSION |
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(String symbolName)
Creates a new
IMultiLayerSymbol . |
ISymbol |
createSymbol(int geomType)
|
ISymbol |
createSymbol(int geomType,
Color color)
|
ISymbol |
createSymbol(String symbolName)
Creates a new
ISymbol . |
ISymbol |
createSymbol(String symbolName,
Color 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[] |
loadSymbols(File folder)
Loads the symbols persisted into a folder.
|
ISymbol[] |
loadSymbols(File folder,
FileFilter filter)
Loads the symbols persisted into a folder.
|
CancellableTask |
loadSymbols(File folder,
FileFilter filter,
Visitor visitor) |
void |
registerMultiLayerSymbol(String symbolName,
Class symbolClass)
Registers a
IMultiLayerSymbol implementation class with a name. |
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 |
registerSymbol(String symbolName,
Class symbolClass)
Registers a
ISymbol 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 |
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) |
static final String LEGEND_FILE_EXTENSION
static final String LABELINGSTRATEGY_FILE_EXTENSION
ISymbol[] loadSymbols(File folder) throws SymbolException
PersistenceManager
, loading all files
found into the folder.folder
- to load the persisted symbols fromSymbolException
- if there is an error loading the symbolsISymbol[] loadSymbols(File folder, FileFilter filter) throws SymbolException
PersistenceManager
, loading the files
found into the folder which apply to the provided filter.folder
- to load the persisted symbols fromfilter
- to apply to know which files to loadSymbolException
- if there is an error loading the symbolsCancellableTask loadSymbols(File folder, FileFilter filter, Visitor visitor)
void saveSymbol(ISymbol symbol, String fileName, File folder) throws SymbolException
ISymbol
into the given folder, with the given file
name.symbol
- to persistfileName
- of the file to createfolder
- where to create the fileSymbolException
- if there is an error persisting the symbol, or the file to
create already existsvoid saveSymbol(ISymbol symbol, String fileName, File folder, boolean overwrite) throws SymbolException
ISymbol
into the given folder, with the given file
name.symbol
- to persistfileName
- of the file to createfolder
- where to create the fileoverwrite
- what to do if the file to create already existsSymbolException
- if there is an error persisting the symbol, or the file to
create already exists and overwrite is falseSymbolPreferences getSymbolPreferences()
SymbolPreferences
.SymbolPreferences
ISymbol createSymbol(String symbolName) throws MapContextRuntimeException
ISymbol
.symbolName
- the name of the symbol to createISymbol
MapContextRuntimeException
- if there is an error creating the symbolISymbol createSymbol(int geomType) throws MapContextRuntimeException
geomType
- the Geometry
type to renderISymbol
MapContextRuntimeException
- if there is an error creating the symbolISymbol createSymbol(String symbolName, Color color) throws MapContextRuntimeException
symbolName
- the name of the symbol to createcolor
- the color for the symbolISymbol
MapContextRuntimeException
- if there is an error creating the symbolISymbol createSymbol(int geomType, Color color) throws MapContextRuntimeException
geomType
- the Geometry
type to rendercolor
- the color for the symbolISymbol
MapContextRuntimeException
- if there is an error creating the symbolIMultiLayerSymbol createMultiLayerSymbol(String symbolName) throws MapContextRuntimeException
IMultiLayerSymbol
.symbolName
- the name of the symbol to createIMultiLayerSymbol
MapContextRuntimeException
- if there is an error creating the symbolIMultiLayerSymbol createMultiLayerSymbol(int geomType) throws MapContextRuntimeException
IMultiLayerSymbol
which can be used to render the
given Geometry
type.geomType
- the Geometry
type to renderIMultiLayerSymbol
MapContextRuntimeException
- if there is an error creating the symbolvoid registerSymbol(String symbolName, Class symbolClass) throws MapContextRuntimeException
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.symbolName
- the symbol namesymbolClass
- the symbol implementation classMapContextRuntimeException
- if the provided class does not implement the ISymbol
interfacevoid registerSymbol(String symbolName, int[] geomTypes, Class symbolClass) throws MapContextException
ISymbol
implementation class with a name and a list
of geometry types which the symbol is able to render.symbolName
- the symbol namegeomTypes
- the list of geometry types the symbol is able to rendersymbolClass
- the symbol implementation classMapContextRuntimeException
- if the provided class does not implement the ISymbol
interfaceMapContextException
void registerMultiLayerSymbol(String symbolName, Class symbolClass) throws MapContextRuntimeException
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.symbolName
- the symbol namesymbolClass
- the symbol implementation classMapContextRuntimeException
- if the provided class does not implement the
IMultiLayerSymbol
interfacevoid registerMultiLayerSymbol(String symbolName, int[] geomTypes, Class symbolClass) throws MapContextRuntimeException
IMultiLayerSymbol
implementation class with a name
and a list of geometry types which the symbol is able to render.symbolName
- the symbol namegeomTypes
- the list of geometry types the symbol is able to rendersymbolClass
- the symbol implementation classMapContextRuntimeException
- if the provided class does not implement the
IMultiLayerSymbol
interfaceIWarningSymbol getWarningSymbol(String message, String symbolDesc, int symbolDrawExceptionType) throws MapContextRuntimeException
IWarningSymbol
.
TODO: revisar el uso de esto, a ver si es necesario o se puede ocultar
dentro de la implementación.message
- symbolDesc
- symbolDrawExceptionType
- MapContextRuntimeException
void setSymbolPreferences(SymbolPreferences symbolPreferences)
List getSymbolLibraryNames()
ISymbol getSymbol(String libraryName, String symbolID) throws SymbolException
SymbolException