org.gvsig.labeling.symbol

Class SmartTextSymbol

java.lang.Object

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

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

org.gvsig.labeling.symbol.SmartTextSymbol

All Implemented Interfaces:

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

public class SmartTextSymbol
extends AbstractSymbol
implements ISimpleTextSymbol

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)and has the property that can follow a path.If this path does not exist, the text is treated as a simpletextsymbol (when is drawn).

Nested Class Summary

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

AbstractSymbol.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	SMART_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
SmartTextSymbol()
SmartTextSymbol(ITextSymbol sym, IPlacementConstraints constraints)

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) Draws the text according.
void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, Feature f, Cancellable cancel, java.awt.Rectangle r)
void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.geom.AffineTransform scaleInstance, java.awt.Rectangle r) Useful to render the symbol inside the TOC, or inside little rectangles.
java.awt.Rectangle	getBounds()
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()
int	getOnePointRgb()
void	getPixExtentPlus(Geometry shp, float[] distances, ViewPort viewPort, int dpi)
double	getRotation()
Geometry	getSampleGeometry(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) Computes a Geometry wrapping the text to be applied
boolean	isAutoresizeEnabled()
boolean	isDrawWithHalo()
boolean	isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi)
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	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	setAlignment(int alignment)
void	setAutoresizeEnabled(boolean ar)
void	setCharacterSpacing(double charSpacing)
void	setColor(java.awt.Color color) Sets the Color to use to render the symbol.
void	setDrawWithHalo(boolean h)
void	setFont(java.awt.Font fnt) Establishes the font that will be used to render this ITextSymbol.
void	setFontSize(double d) Sets the font size currently set to this symbol
void	setHaloColor(java.awt.Color co)
void	setHaloWidth(float w)
void	setKerning(boolean kerning)
void	setMargin(double margin)
void	setRightToLeft(boolean rightToLeft)
void	setRotation(double rot) Defines the angle of rotation for the text that composes the symbol
void	setText(java.lang.String txt) Sets the text to be rendered by this symbol
void	setTextColor(java.awt.Color color) Sets the color of the text
void	setWordSpacing(double wordSpacing)

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

cloneForSelection, cloneForSelection, 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.fmap.mapcontext.rendering.symbols.ISymbol

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

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

SMART_TEXT_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SMART_TEXT_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

SmartTextSymbol

public SmartTextSymbol(ITextSymbol sym,
                       IPlacementConstraints constraints)

SmartTextSymbol

public SmartTextSymbol()

Method Detail

draw

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

Draws the text according. If this symbol has the text path set, then it is used as the text line, otherwise shp must be an FPoint2D indicating the starting point of the text and then the text will be rendered from there and following the rotation previously set.

Specified by:

draw in interface ISymbol

Overrides:

draw in class AbstractSymbol

cancel - TODO

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

getPixExtentPlus

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

getOnePointRgb

public int getOnePointRgb()

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:

getSampleGeometry

public Geometry getSampleGeometry(java.awt.Rectangle r)

drawInsideRectangle

public void drawInsideRectangle(java.awt.Graphics2D g,
                                java.awt.geom.AffineTransform scaleInstance,
                                java.awt.Rectangle r)
                         throws SymbolDrawingException

Description copied from interface: ISymbol

Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course, you can also to choose to render a prepared image, etc.

Specified by:

drawInsideRectangle in interface ISymbol

Overrides:

drawInsideRectangle in class AbstractSymbol

Throws:

SymbolDrawingException - TODO

setText

public void setText(java.lang.String txt)

Description copied from interface: ITextSymbol

Sets the text to be rendered by this symbol

Specified by:

setText in interface ITextSymbol

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:

setCharacterSpacing

public void setCharacterSpacing(double charSpacing)

setWordSpacing

public void setWordSpacing(double wordSpacing)

setAlignment

public void setAlignment(int alignment)

setKerning

public void setKerning(boolean kerning)

setMargin

public void setMargin(double margin)

setRightToLeft

public void setRightToLeft(boolean rightToLeft)

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.

isOneDotOrPixel

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

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

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

setFont

public void setFont(java.awt.Font fnt)

Description copied from interface: ITextSymbol

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

Specified by:

setFont in interface ITextSymbol

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

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

setFontSize

public void setFontSize(double d)

Description copied from interface: ITextSymbol

Sets the font size currently set to this symbol

Specified by:

setFontSize in interface ITextSymbol

getTextWrappingShape

public Geometry getTextWrappingShape(Point p)

Description copied from interface: ITextSymbol

Computes a Geometry wrapping the text to be applied

Specified by:

getTextWrappingShape in interface ITextSymbol

Parameters:

p - target location

Returns:

getBounds

public java.awt.Rectangle getBounds()

Specified by:

getBounds in interface ITextSymbol

getRotation

public double getRotation()

Specified by:

getRotation in interface ISimpleTextSymbol

setRotation

public void setRotation(double rot)

Description copied from interface: ISimpleTextSymbol

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

Specified by:

setRotation in interface ISimpleTextSymbol

setAutoresizeEnabled

public void setAutoresizeEnabled(boolean ar)

Specified by:

setAutoresizeEnabled in interface ITextSymbol

isAutoresizeEnabled

public boolean isAutoresizeEnabled()

Specified by:

isAutoresizeEnabled in interface ITextSymbol

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 w)

Specified by:

setHaloWidth in interface ITextSymbol

isDrawWithHalo

public boolean isDrawWithHalo()

Specified by:

isDrawWithHalo in interface ITextSymbol

setDrawWithHalo

public void setDrawWithHalo(boolean h)

Specified by:

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

registerPersistent

public static void registerPersistent()

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