org.gvsig.fmap.mapcontext.rendering.symbols

Interface SymbolPreferences

All Known Implementing Classes:

AppSymbolPreferences, DefaultSymbolPreferences

public interface SymbolPreferences

Preferences for symbol configuration and default values.

Method Summary

Modifier and Type	Method and Description
int	getDefaultCartographicSupportMeasureUnit() Returns the unit that will be used when creating new symbols with Cartographic support.
int	getDefaultCartographicSupportReferenceSystem() Returns the reference system that will be used when creating new symbols with Cartographic support.
java.awt.Color	getDefaultSymbolColor() Returns the default color to use for symbols.
java.awt.Color	getDefaultSymbolFillColor() Returns the default fill color to use for symbols.
java.awt.Font	getDefaultSymbolFont() Returns the default font to use for symbols.
java.lang.String	getSymbolFileExtension() Returns the file extension to use for persisted symbols.
java.lang.String	getSymbolLibraryPath() Returns the path to the symbol library, where the persisted symbols can be found.
boolean	isDefaultSymbolFillColorAleatory() Returns if the default symbol fill color has been generated in a aleatory way.
void	resetDefaultSymbolColor() Sets the default color for symbols to the original value.
void	resetDefaultSymbolFillColor() Sets the default fill color for symbols to the original value.
void	resetDefaultSymbolFillColorAleatory() Sets if the default symbol fill color is aleatory to the default value.
void	resetDefaultSymbolFont() Sets the default font to use for symbols to the original value.
void	resetSymbolLibraryPath() Sets the path to the symbol library to the original value.
void	setDefaultCartographicSupportMeasureUnit(int defaultCartographicSupportMeasureUnit) Sets the unit that will be used when creating new symbols with Cartographic support.
void	setDefaultCartographicSupportReferenceSystem(int defaultCartographicSupportReferenceSystem) Sets the reference system that will be used when creating new symbols with Cartographic support.
void	setDefaultSymbolColor(java.awt.Color defaultSymbolColor) Sets the default color to use for symbols.
void	setDefaultSymbolFillColor(java.awt.Color defaultSymbolFillColor) Sets the default fill color to use for symbols.
void	setDefaultSymbolFillColorAleatory(boolean defaultSymbolFillColorAleatory) Sets if the default symbol fill color has been generated in a aleatory way.
void	setDefaultSymbolFont(java.awt.Font defaultSymbolFont) Sets the default font to use for symbols.
void	setSymbolFileExtension(java.lang.String extension) Sets the file extension to use for persisted symbols.
void	setSymbolLibraryPath(java.lang.String symbolLibraryPath) Sets the path to the symbol library, where the persisted symbols can be found.

Method Detail

getSymbolFileExtension

java.lang.String getSymbolFileExtension()

Returns the file extension to use for persisted symbols.

Returns:

the symbol file extension

setSymbolFileExtension

void setSymbolFileExtension(java.lang.String extension)

Sets the file extension to use for persisted symbols.

Parameters:

extension - the file extension to use for persisted symbols

getDefaultSymbolColor

java.awt.Color getDefaultSymbolColor()

Returns the default color to use for symbols.

Returns:

the symbol default color

setDefaultSymbolColor

void setDefaultSymbolColor(java.awt.Color defaultSymbolColor)

Sets the default color to use for symbols.

Parameters:

defaultSymbolColor - the symbol default color

resetDefaultSymbolColor

void resetDefaultSymbolColor()

Sets the default color for symbols to the original value.

getDefaultSymbolFillColor

java.awt.Color getDefaultSymbolFillColor()

Returns the default fill color to use for symbols.

Returns:

the default fill color

setDefaultSymbolFillColor

void setDefaultSymbolFillColor(java.awt.Color defaultSymbolFillColor)

Sets the default fill color to use for symbols.

Parameters:

defaultSymbolFillColor - the default fill color

resetDefaultSymbolFillColor

void resetDefaultSymbolFillColor()

Sets the default fill color for symbols to the original value.

isDefaultSymbolFillColorAleatory

boolean isDefaultSymbolFillColorAleatory()

Returns if the default symbol fill color has been generated in a aleatory way.

Returns:

if the default symbol fill color is aleatory

setDefaultSymbolFillColorAleatory

void setDefaultSymbolFillColorAleatory(boolean defaultSymbolFillColorAleatory)

Sets if the default symbol fill color has been generated in a aleatory way.

Parameters:

defaultSymbolFillColorAleatory - if the default symbol fill color is aleatory

resetDefaultSymbolFillColorAleatory

void resetDefaultSymbolFillColorAleatory()

Sets if the default symbol fill color is aleatory to the default value.

getDefaultSymbolFont

java.awt.Font getDefaultSymbolFont()

Returns the default font to use for symbols.

Returns:

the default symbol font

setDefaultSymbolFont

void setDefaultSymbolFont(java.awt.Font defaultSymbolFont)

Sets the default font to use for symbols.

Parameters:

defaultSymbolFont - the default symbol font

resetDefaultSymbolFont

void resetDefaultSymbolFont()

Sets the default font to use for symbols to the original value.

getSymbolLibraryPath

java.lang.String getSymbolLibraryPath()

Returns the path to the symbol library, where the persisted symbols can be found.

Returns:

the path to the symbol library

setSymbolLibraryPath

void setSymbolLibraryPath(java.lang.String symbolLibraryPath)

Sets the path to the symbol library, where the persisted symbols can be found.

Parameters:

symbolLibraryPath - the path to the symbol library

resetSymbolLibraryPath

void resetSymbolLibraryPath()

Sets the path to the symbol library to the original value.

getDefaultCartographicSupportMeasureUnit

int getDefaultCartographicSupportMeasureUnit()

Returns the unit that will be used when creating new symbols with Cartographic support.

Returns:

the default cartographic support measure unit

See Also:

CartographicSupport.getUnit()

setDefaultCartographicSupportMeasureUnit

void setDefaultCartographicSupportMeasureUnit(int defaultCartographicSupportMeasureUnit)

Sets the unit that will be used when creating new symbols with Cartographic support.

Parameters:

defaultCartographicSupportMeasureUnit - the default cartographic support measure unit

See Also:

CartographicSupport#setUnit()

getDefaultCartographicSupportReferenceSystem

int getDefaultCartographicSupportReferenceSystem()

Returns the reference system that will be used when creating new symbols with Cartographic support.

Returns:

the cartographic reference system

See Also:

CartographicSupport.PAPER, CartographicSupport.WORLD

setDefaultCartographicSupportReferenceSystem

void setDefaultCartographicSupportReferenceSystem(int defaultCartographicSupportReferenceSystem)

Sets the reference system that will be used when creating new symbols with Cartographic support.

Parameters:

defaultCartographicSupportReferenceSystem - the cartographic reference system

See Also:

CartographicSupport.PAPER, CartographicSupport.WORLD