org.gvsig.labeling.symbol

Class SmartTextSymbol

java.lang.Object

org.gvsig.labeling.symbol.SmartTextSymbol

All Implemented Interfaces:

Cloneable, CartographicSupport, IPrintable, ISymbol, ITextSymbol, ISimpleTextSymbol, Persistent

public class SmartTextSymbol
extends Object
implements ISimpleTextSymbol, CartographicSupport

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SMART_TEXT_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
Object	clone() Creates a copy of the object.
void	draw(Graphics2D g, AffineTransform affineTransform, Geometry geom, Feature f, Cancellable cancel) Draws the text according.
void	drawInsideRectangle(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties) Useful to render the symbol inside the TOC, or inside little rectangles.
Rectangle	getBounds()
double	getCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
Color	getColor() Returns the Color to use to render the symbol.
String	getDescription() The description is a human-readable text used to label it when show in a symbol menu or something like that.
Font	getFont() Returns the currently set font.
Color	getHaloColor()
float	getHaloWidth()
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
void	getPixExtentPlus(Geometry shp, float[] distances, ViewPort viewPort, int dpi) Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.
int	getReferenceSystem() Returns the Reference System used to draw the elements of the image.
double	getRotation()
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.
String	getText() Returns the text contained by this symbol
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
int	getUnit() Returns the unit used to express measures.
boolean	isAutoresizeEnabled()
boolean	isDrawWithHalo()
boolean	isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi) Informs that the geometry will be represented with that symbol in just one pixel or dot
boolean	isShapeVisible() Tells whether the shape of the symbol will be drawn or not.
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(Graphics2D g, 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	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setCharacterSpacing(double charSpacing)
void	setColor(Color color) Sets the Color to use to render the symbol.
void	setDescription(String d) Sets the description of this symbol
void	setDrawWithHalo(boolean h)
void	setFont(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(Color co)
void	setHaloWidth(float w)
void	setIsShapeVisible(boolean v)
void	setKerning(boolean kerning)
void	setMargin(double margin)
void	setReferenceSystem(int rs) Sets the Reference System that defines how this units have to be handled.
void	setRightToLeft(boolean rightToLeft)
void	setRotation(double rot) Defines the angle of rotation for the text that composes the symbol
void	setText(String txt) Sets the text to be rendered by this symbol
void	setTextColor(Color color) Sets the color of the text
void	setUnit(int unitIndex) Defines the unit used to express measures.
void	setWordSpacing(double wordSpacing)
double	toCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Methods inherited from class java.lang.Object

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

Field Detail

SMART_TEXT_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final 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

setIsShapeVisible

public void setIsShapeVisible(boolean v)

isShapeVisible

public boolean isShapeVisible()

Description copied from interface: ISymbol

Tells whether the shape of the symbol will be drawn or not.

Specified by:

isShapeVisible in interface ISymbol

Returns:

true if Shape must be drawn. Useful if you are labelling

draw

public void draw(Graphics2D g,
                 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

cancel - TODO

getPixExtentPlus

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

Description copied from interface: ISymbol

Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.

After this method returns, the float array passed will contain two values representing the amount of pixels separating each of the X (first element) and Y (second element) axes.

This distance maybe dependent on:

1. The ViewPort: if the symbol is an instance of CartographicSupport the units it uses are not pixels and the reference system is CarthographicSupport.WORLD.
2. The target rendering context's dpi (dots-per-inch): if the symbol is an instance of CartographicSupport the units it uses are not pixels and CarthographicSupport.PAPER.

And in any other case, if the unit of the symbol is pixels or the symbol is not even an instance of CartographicSupport, the returning values are only defined by the symbol and are not calculated.

Specified by:

getPixExtentPlus in interface ISymbol

getOnePointRgb

public int getOnePointRgb()

Description copied from interface: ISymbol

Returns the rgb of the symbol when it is drawn like a point.

Specified by:

getOnePointRgb in interface ISymbol

Returns:

rgb of the symbol.

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:

drawInsideRectangle

public void drawInsideRectangle(Graphics2D g,
                                AffineTransform scaleInstance,
                                Rectangle r,
                                PrintAttributes properties)
                         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

properties - TODO

Throws:

SymbolDrawingException - TODO

setText

public void setText(String txt)

Description copied from interface: ITextSymbol

Sets the text to be rendered by this symbol

Specified by:

setText in interface ITextSymbol

getText

public 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

Returns:

ISymbol applied to a feature when it has been selected.

isOneDotOrPixel

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

Description copied from interface: ISymbol

Informs that the geometry will be represented with that symbol in just one pixel or dot

Specified by:

isOneDotOrPixel in interface ISymbol

positionOfDotOrPixel - (out) filled with pixel or dot location

Returns:

getDescription

public String getDescription()

Description copied from interface: ISymbol

The description is a human-readable text used to label it when show in a symbol menu or something like that.

Specified by:

getDescription in interface ISymbol

Returns:

description of this symbol.

setDescription

public void setDescription(String d)

Description copied from interface: ISymbol

Sets the description of this symbol

Specified by:

setDescription in interface ISymbol

See Also:

ISymbol.getDescription();

getColor

public 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(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(Graphics2D g,
                  AffineTransform at,
                  Geometry geom,
                  PrintAttributes properties)

Specified by:

print in interface IPrintable

setFont

public void setFont(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 Font getFont()

Description copied from interface: ITextSymbol

Returns the currently set font.

Specified by:

getFont in interface ITextSymbol

Returns:

Font

getTextColor

public 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(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 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 Color getHaloColor()

Specified by:

getHaloColor in interface ITextSymbol

setHaloColor

public void setHaloColor(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

setUnit

public void setUnit(int unitIndex)

Description copied from interface: CartographicSupport

Defines the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

Specified by:

setUnit in interface CartographicSupport

getUnit

public int getUnit()

Description copied from interface: CartographicSupport

Returns the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

Specified by:

getUnit in interface CartographicSupport

getReferenceSystem

public int getReferenceSystem()

Description copied from interface: CartographicSupport

Returns the Reference System used to draw the elements of the image.

The elements have to be scaled to pixel when the image is bein drawn in order to compose the map. The elements of the map may define its size in other units than pixel.

CartographicSupport enables the elements to define the size in measure units but these units may refer to different reference system. Two kinds of Reference Systems are allowed in this context: CartographicSupport.WORLD, and CartographicSupport.PAPER.

Depending on which Reference System is used the unit used by this element refers to distances in the real world (then they are map's CRS-dependant) or screen or printer output (then they are output DPI-dependant)

In case the unit used is pixel then the reference system does not have any effect since the source unit is the same than the target unit.

Specified by:

getReferenceSystem in interface CartographicSupport

Returns:

setReferenceSystem

public void setReferenceSystem(int rs)

Description copied from interface: CartographicSupport

Sets the Reference System that defines how this units have to be handled. Possible values are:

1. CartographySupport.WORLD: Defines that the unit values refer to distances in the world. So, the size of the element displayed depends directly on the scale and CRS used by the map. The size of the elements defined to use CartographicSupport.WORLD will match exactly to their actual size in the real world.
2. CartographySupport.PAPER: Defines that the unit values refer to the length that the element will have regardless where it appears. If ReferenceSystem is CartographySupport.PAPER, and the length is (e.g.) millimeters the element will be displayed with the same amount of millimeters of length whether in the screen or the printer (screen DPI and printer DPI must be correctly configured).

Specified by:

setReferenceSystem in interface CartographicSupport

setCartographicSize

public void setCartographicSize(double cartographicSize,
                                Geometry geom)

Description copied from interface: CartographicSupport

Sets the size of the cartographic element in pixels.

Specified by:

setCartographicSize in interface CartographicSupport

toCartographicSize

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

Description copied from interface: CartographicSupport

Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

toCartographicSize in interface CartographicSupport

Returns:

a double containing the previous defined size

getCartographicSize

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

Description copied from interface: CartographicSupport

Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

getCartographicSize in interface CartographicSupport

Returns:

double containing the size in [screen/printer] pixels for the current symbol

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class Object

Returns:

a copy of the object

Throws:

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

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

Throws:

PersistenceException