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

Class SimpleTextSymbol

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.text.impl.SimpleTextSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, ITextSymbol, ISimpleTextSymbol, Persistent

public class SimpleTextSymbol
extends AbstractSymbol
implements ITextSymbol, ISimpleTextSymbol

SimpleTextSymbol is a class used to create symbols composed using a text defined by the user.This text can be edited (changing the color, the font of the characters, and the rotation of the text).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleTextSymbol.RegisterPersistence
static class	SimpleTextSymbol.RegisterSymbol

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	SIMPLE_TEXT_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.fmap.mapcontext.rendering.symbols.ITextSymbol

SYMBOL_NAME, SYMBOL_STYLE_ALIGNMENT_CENTERED, SYMBOL_STYLE_ALIGNMENT_JUSTIFY, SYMBOL_STYLE_ALIGNMENT_LEFT, SYMBOL_STYLE_ALIGNMENT_RIGHT

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

SELECTION_COLOR

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

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
SimpleTextSymbol()

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 f, Cancellable cancel, java.awt.Rectangle r)
java.awt.Rectangle	getBounds()
double	getCartographicSize(ViewPort viewPort, double dpi, Geometry geom)
java.lang.String	getClassName()
java.awt.Color	getColor() Returns the Color to use to render the symbol.
java.awt.Font	getFont() Returns the currently set font.
java.awt.Color	getHaloColor()
float	getHaloWidth()
double	getRotation()
protected Point	getSamplePoint(java.awt.Rectangle r)
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
java.lang.String	getText() Returns the text contained by this symbol
java.awt.Color	getTextColor() Returns the currently color set to be applied to the text
Geometry	getTextWrappingShape(Point p) Returns an Geometry which represents a rectangle containing the text in screen units.
boolean	isAutoresizeEnabled()
boolean	isDrawWithHalo()
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAutoresizeEnabled(boolean autoresizeFlag)
void	setCartographicSize(double cartographicSize, Geometry geom)
void	setColor(java.awt.Color color) Sets the Color to use to render the symbol.
void	setDrawWithHalo(boolean drawWithHalo)
void	setFont(java.awt.Font font) Establishes the font that will be used to render this ITextSymbol.
void	setFontSize(double size) Sets the font size currently set to this symbol
void	setHaloColor(java.awt.Color co)
void	setHaloWidth(float haloWidth)
void	setRotation(double rotation) Defines the angle of rotation for the text that composes the symbol
void	setText(java.lang.String text) Sets the text to be rendered by this symbol
void	setTextColor(java.awt.Color color) Sets the color of the text
double	toCartographicSize(ViewPort viewPort, double dpi, Geometry geom)

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

cloneForSelection, cloneForSelection, draw, drawInsideRectangle, equals, getDescription, getFeature, getID, getRequiredFeatureAttributeNames, getSymbolForSelection, isShapeVisible, print, 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.fmap.mapcontext.rendering.symbols.ISymbol

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

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

print

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

cloneQuietly, cloneQuietly

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

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

Field Detail

SIMPLE_TEXT_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SIMPLE_TEXT_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

SimpleTextSymbol

public SimpleTextSymbol()

Method Detail

draw

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

Specified by:

draw in interface ISymbol

getSymbolForSelection

public ISymbol getSymbolForSelection()

Description copied from interface: ISymbol

Returns the derived version of the symbol that will be used to draw the feature when it is selected.

Specified by:

getSymbolForSelection in interface ISymbol

Overrides:

getSymbolForSelection in class AbstractSymbol

Returns:

ISymbol applied to a feature when it has been selected.

getSymbolType

public int getSymbolType()

Description copied from interface: ISymbol

The use of this method -and its mechanism- is being valorated. It probably will be deprecated.

Specified by:

getSymbolType in interface ISymbol

Returns:

FSymbol constants. I think it is better to use isSuitableFor

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

Returns:

getClassName

public java.lang.String getClassName()

getText

public java.lang.String getText()

Description copied from interface: ITextSymbol

Returns the text contained by this symbol

Specified by:

getText in interface ITextSymbol

Returns:

getFont

public java.awt.Font getFont()

Description copied from interface: ITextSymbol

Returns the currently set font.

Specified by:

getFont in interface ITextSymbol

Returns:

Font

getTextColor

public java.awt.Color getTextColor()

Description copied from interface: ITextSymbol

Returns the currently color set to be applied to the text

Specified by:

getTextColor in interface ITextSymbol

Returns:

Color

setText

public void setText(java.lang.String text)

Description copied from interface: ITextSymbol

Sets the text to be rendered by this symbol

Specified by:

setText in interface ITextSymbol

setFont

public void setFont(java.awt.Font font)

Description copied from interface: ITextSymbol

Establishes the font that will be used to render this ITextSymbol.

Specified by:

setFont in interface ITextSymbol

setTextColor

public void setTextColor(java.awt.Color color)

Description copied from interface: ITextSymbol

Sets the color of the text

Specified by:

setTextColor in interface ITextSymbol

getColor

public java.awt.Color getColor()

Description copied from interface: ISymbol

Returns the Color to use to render the symbol.

Specified by:

getColor in interface ISymbol

Returns:

the Color to use to render the symbol

setColor

public void setColor(java.awt.Color color)

Description copied from interface: ISymbol

Sets the Color to use to render the symbol.

Specified by:

setColor in interface ISymbol

Parameters:

color - to render the symbol

setFontSize

public void setFontSize(double size)

Description copied from interface: ITextSymbol

Sets the font size currently set to this symbol

Specified by:

setFontSize in interface ITextSymbol

getRotation

public double getRotation()

Specified by:

getRotation in interface ISimpleTextSymbol

setRotation

public void setRotation(double rotation)

Defines the angle of rotation for the text that composes the symbol

Specified by:

setRotation in interface ISimpleTextSymbol

Parameters:

rotation -

getTextWrappingShape

public Geometry getTextWrappingShape(Point p)

Returns an Geometry which represents a rectangle containing the text in screen units.

Specified by:

getTextWrappingShape in interface ITextSymbol

Parameters:

p - target location

Returns:

getBounds

public java.awt.Rectangle getBounds()

Specified by:

getBounds in interface ITextSymbol

setCartographicSize

public void setCartographicSize(double cartographicSize,
                                Geometry geom)

toCartographicSize

public double toCartographicSize(ViewPort viewPort,
                                 double dpi,
                                 Geometry geom)

getCartographicSize

public double getCartographicSize(ViewPort viewPort,
                                  double dpi,
                                  Geometry geom)

isAutoresizeEnabled

public boolean isAutoresizeEnabled()

Specified by:

isAutoresizeEnabled in interface ITextSymbol

setAutoresizeEnabled

public void setAutoresizeEnabled(boolean autoresizeFlag)

Specified by:

setAutoresizeEnabled in interface ITextSymbol

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 AbstractSymbol

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()}.

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 AbstractSymbol

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 AbstractSymbol

Throws:

PersistenceException

getHaloColor

public java.awt.Color getHaloColor()

Specified by:

getHaloColor in interface ITextSymbol

setHaloColor

public void setHaloColor(java.awt.Color co)

Specified by:

setHaloColor in interface ITextSymbol

getHaloWidth

public float getHaloWidth()

Specified by:

getHaloWidth in interface ITextSymbol

setHaloWidth

public void setHaloWidth(float haloWidth)

Specified by:

setHaloWidth in interface ITextSymbol

isDrawWithHalo

public boolean isDrawWithHalo()

Specified by:

isDrawWithHalo in interface ITextSymbol

setDrawWithHalo

public void setDrawWithHalo(boolean drawWithHalo)

Specified by:

setDrawWithHalo in interface ITextSymbol

getSamplePoint

protected Point getSamplePoint(java.awt.Rectangle r)