org.gvsig.labeling.symbol

Class CharacterMarkerSymbol

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractCartographicSupport

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl.AbstractMarkerSymbol

org.gvsig.labeling.symbol.CharacterMarkerSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, IMarkerSymbol, IMarkerSymbol_v2, Persistent

public class CharacterMarkerSymbol
extends AbstractMarkerSymbol
implements IMarkerSymbol_v2

Allows to use a source of TrueType characters to define the marker that will substitute the symbol.If the picture is defined in a source, the performance is more agile.

Nested Class Summary

Nested classes/interfaces inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl.AbstractMarkerSymbol

AbstractMarkerSymbol.RegisterPersistence

Nested classes/interfaces inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

CartographicSupport.CartographicContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl.AbstractMarkerSymbol

MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

LOGGER, SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol

CIRCLE_STYLE, CROSS_STYLE, DIAMOND_STYLE, HORIZONTAL_LINE_STYLE, SQUARE_STYLE, STAR_STYLE, SYMBOL_NAME, TRIANGLE_STYLE, VERTICAL_LINE_STYLE, X_STYLE

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

PAPER, WORLD

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

SELECTION_COLOR

Constructor Summary

Constructors

Constructor and Description
CharacterMarkerSymbol() Creates a new instance of CharacterMarker with default values
CharacterMarkerSymbol(java.awt.Font font, int charCode, java.awt.Color color) Creates a new instance of CharacterMarker specifying the marker source font, the character code corresponding to the symbol, and the color that will be used in rendering time.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, Feature feat, Cancellable cancel, java.awt.Rectangle r)
java.awt.Font	getFont() Returns the font that will be used to define the symbol
int	getOnePointRgb()
void	getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi)
ISymbol	getSymbolForSelection(java.awt.Color selectionColor)
int	getUnicode() Obtains the unicode for a symbol
boolean	isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi)
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
boolean	isVisuallyCorrected() Returns true of false depending if the character marker symbol selected is visually corrected.That is, if the character has been properly scaled to use a specific number of pixels to be represented.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, Geometry geom, PrintAttributes properties)
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAlpha(int a) Defines the transparency of a line symbol.
void	setFont(java.awt.Font font) Sets the font that will be used to define the symbol
void	setSize(double size) Sets the size of marker symbol
void	setUnicode(int symbol) Sets the unicode for a symbol represented by a character
void	setVisuallyCorrected(boolean visuallyCorrected) Sets the visual correction for a character in order to scale it if it is necessary.

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl.AbstractMarkerSymbol

getAdjustedSize, getCartographicSize, getColor, getEfectiveLineToOffsetColor, getEfectiveOffset, getEfectiveRotationInDegres, getEfectiveRotationInRadians, getEfectiveSize, getLineToOffsetColor, getLineToOffsetColorExpression, getMask, getOffset, getOffsetXExpression, getOffsetYExpression, getPoint, getRotation, getRotationExpression, getRotationInDegrees, getRotationInRadians, getSampleGeometry, getSize, getSizeExpression, getSymbolTable, getSymbolType, isDrawLineToOffset, setColor, setDrawLineToOffset, setLineToOffsetColor, setLineToOffsetColorExpression, setMask, setOffset, setOffsetXExpression, setOffsetYExpression, setRotation, setRotationExpression, setRotationInDegrees, setRotationInRadians, setSizeExpression

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

cloneForSelection, cloneForSelection, draw, drawInsideRectangle, equals, getDescription, getFeature, getID, getRequiredFeatureAttributeNames, getSymbolForSelection, isShapeVisible, setDescription, setFeature, setID, setIsShapeVisible

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractCartographicSupport

copyCartographicContext, getCartographicContext, getReferenceSystem, getUnit, isInPixels, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setReferenceSystem, setUnit, toCartographicUnits

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol_v2

getEfectiveLineToOffsetColor, getEfectiveOffset, getEfectiveRotationInDegres, getEfectiveRotationInRadians, getEfectiveSize, getLineToOffsetColor, getLineToOffsetColorExpression, getOffsetXExpression, getOffsetYExpression, getRotationExpression, getSizeExpression, isDrawLineToOffset, setDrawLineToOffset, setLineToOffsetColor, setLineToOffsetColorExpression, setOffsetXExpression, setOffsetYExpression, setRotationExpression, setSizeExpression

Methods inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol

getColor, getMask, getOffset, getRotation, getSize, setColor, setMask, setOffset, setRotation

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

copyCartographicContext, copyCartographicContext, getCartographicContext, getReferenceSystem, getUnit, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setReferenceSystem, setUnit, toCartographicUnits

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

draw, drawInsideRectangle, getDescription, getFeature, getID, getSymbolForSelection, getSymbolType, isShapeVisible, setDescription, setFeature, setID

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Field Detail

CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME

public static final java.lang.String CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME

See Also:

Constant Field Values

Constructor Detail

CharacterMarkerSymbol

public CharacterMarkerSymbol()

Creates a new instance of CharacterMarker with default values

CharacterMarkerSymbol

public CharacterMarkerSymbol(java.awt.Font font,
                             int charCode,
                             java.awt.Color color)

Creates a new instance of CharacterMarker specifying the marker source font, the character code corresponding to the symbol, and the color that will be used in rendering time.

Parameters:

font - - src Font

charCode - - character code of the symbol for this font

color - - color to be used in when rendering.

Method Detail

getFont

public java.awt.Font getFont()

Returns the font that will be used to define the symbol

Returns:

font

setFont

public void setFont(java.awt.Font font)

Sets the font that will be used to define the symbol

getSymbolForSelection

public ISymbol getSymbolForSelection(java.awt.Color selectionColor)

Specified by:

getSymbolForSelection in interface ISymbol

Overrides:

getSymbolForSelection in class AbstractSymbol

draw

public void draw(java.awt.Graphics2D g,
                 java.awt.geom.AffineTransform affineTransform,
                 Geometry geom,
                 Feature feat,
                 Cancellable cancel,
                 java.awt.Rectangle r)

Specified by:

draw in interface ISymbol

setUnicode

public void setUnicode(int symbol)

Sets the unicode for a symbol represented by a character

Parameters:

symbol, - int

getUnicode

public int getUnicode()

Obtains the unicode for a symbol

Returns:

unicode, int

setSize

public void setSize(double size)

Description copied from interface: IMarkerSymbol

Sets the size of marker symbol

Specified by:

setSize in interface IMarkerSymbol

Overrides:

setSize in class AbstractMarkerSymbol

isVisuallyCorrected

public boolean isVisuallyCorrected()

Returns true of false depending if the character marker symbol selected is visually corrected.That is, if the character has been properly scaled to use a specific number of pixels to be represented.

Returns:

boolean

setVisuallyCorrected

public void setVisuallyCorrected(boolean visuallyCorrected)

Sets the visual correction for a character in order to scale it if it is necessary.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractMarkerSymbol

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

getPixExtentPlus

public void getPixExtentPlus(Geometry geom,
                             float[] distances,
                             ViewPort viewPort,
                             int dpi)

isOneDotOrPixel

public boolean isOneDotOrPixel(Geometry geom,
                               double[] positionOfDotOrPixel,
                               ViewPort viewPort,
                               int dpi)

getOnePointRgb

public int getOnePointRgb()

isSuitableFor

public boolean isSuitableFor(Geometry geom)

Description copied from interface: ISymbol

True if this symbol is ok for the geometry. For example, a FillSymbol will be suitable for a Polygon.

Specified by:

isSuitableFor in interface ISymbol

Overrides:

isSuitableFor in class AbstractMarkerSymbol

Returns:

print

public void print(java.awt.Graphics2D g,
                  java.awt.geom.AffineTransform at,
                  Geometry geom,
                  PrintAttributes properties)

Specified by:

print in interface IPrintable

Overrides:

print in class AbstractSymbol

setAlpha

public void setAlpha(int a)

Description copied from interface: IMarkerSymbol

Defines the transparency of a line symbol.

Specified by:

setAlpha in interface IMarkerSymbol

Overrides:

setAlpha in class AbstractMarkerSymbol

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractMarkerSymbol

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractMarkerSymbol

Throws:

PersistenceException

registerPersistent

public static void registerPersistent()