org.gvsig.labeling.label

Class SmartTextSymbolLabelClass

java.lang.Object

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

org.gvsig.labeling.label.SmartTextSymbolLabelClass

All Implemented Interfaces:

java.lang.Cloneable, ILabelClass, CartographicSupport, Persistent

public class SmartTextSymbolLabelClass
extends AbstractCartographicSupport
implements ILabelClass

SmartTextSymbolLabelClass.java

This is a wrapper to be able to use a SmartTextSymbol as a LabelClass. A SmartTextSymbol uses a line instead of a point. Being in fact a Line and not a Marker, it does not make any sense to have label styles since the label styles are well-defined rectangle areas where texts are placed in fields backgrounded by an image. In this contexts, the area is defined dinamically for each line, and there is no sense to have texts fields. They will be rendered as a single string along a line.

The label itself is the SmartTextSymbol, the geometry (the line), the label expression, and the text applied to the symbol.

Most of the operations performed by this LabelClass are in fact delegated to the symbol.

Nested Class Summary

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_LABEL_CLASS_PERSISTENCE_DEFINITION_NAME

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

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
SmartTextSymbolLabelClass()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
void	draw(java.awt.Graphics2D graphics, ILabelLocationMetrics llm, Geometry geo) LabelLocationMetrics, contains the anchor point, rotation, and some other geometric calculations computed by the PlacementManager.
void	drawInsideRectangle(java.awt.Graphics2D graphics, java.awt.Rectangle bounds) Useful to render a Label with size inside little rectangles.
java.awt.Rectangle	getBounds()
java.lang.String	getClassName()
java.lang.String[]	getLabelExpressions() Returns the expression that defines the text which will be showed in the label
ILabelStyle	getLabelStyle() Returns the style of the label
java.lang.String	getName() Returns the name of the label
int	getPriority()
Geometry	getShape(ILabelLocationMetrics llm)
java.lang.String	getSQLQuery()
java.lang.String	getStringLabelExpression() Returns the expression that defines the text which will be showed in the label ready to be used for the label parser
java.lang.String[]	getTexts() Return the text for the label
ITextSymbol	getTextSymbol() Returns the text symbol that is being used for the text(the font, size,style,aligment)
boolean	isUseSqlQuery()
boolean	isVisible() Returns true if the label will be showed in the map
boolean	isVisible(double scale) Returns true if the label will be showed in the map
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setCartographicContext(CartographicSupport.CartographicContext ctx)
void	setLabelExpressions(java.lang.String[] lbl_exps) Sets the expression that defines the text which will be showed in the label
void	setLabelStyle(ILabelStyle labelStyle) Stablishes the style for the label.
void	setName(java.lang.String name) Stablishes the name of the label
void	setPriority(int priority)
void	setSQLQuery(java.lang.String sqlQuery)
void	setTexts(java.lang.String[] texts) Sets the text for the label
void	setTextSymbol(ITextSymbol textSymbol) Stablishes the text symbol that is going to be used for the text(the font,size,style,aligment)
void	setUseSqlQuery(boolean use_sql)
void	setVisible(boolean isVisible) Sets the visibility of the label in the map.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.styling.ILabelClass

toString

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, setReferenceSystem, setUnit, toCartographicUnits

Field Detail

SMART_LABEL_CLASS_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SMART_LABEL_CLASS_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

SmartTextSymbolLabelClass

public SmartTextSymbolLabelClass()

Method Detail

draw

public void draw(java.awt.Graphics2D graphics,
                 ILabelLocationMetrics llm,
                 Geometry geo)

Description copied from interface: ILabelClass

LabelLocationMetrics, contains the anchor point, rotation, and some other geometric calculations computed by the PlacementManager.

The shp argument is passed as an accessory for subclasses of this class in case they need futher geometric calculations

Specified by:

draw in interface ILabelClass

drawInsideRectangle

public void drawInsideRectangle(java.awt.Graphics2D graphics,
                                java.awt.Rectangle bounds)
                         throws SymbolDrawingException

Description copied from interface: ILabelClass

Useful to render a Label with size inside little rectangles.

Specified by:

drawInsideRectangle in interface ILabelClass

Parameters:

graphics - Graphics2D

bounds - Rectangle

Throws:

SymbolDrawingException

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface ILabelClass

getLabelStyle

public ILabelStyle getLabelStyle()

Description copied from interface: ILabelClass

Returns the style of the label

Specified by:

getLabelStyle in interface ILabelClass

getTextSymbol

public ITextSymbol getTextSymbol()

Description copied from interface: ILabelClass

Returns the text symbol that is being used for the text(the font, size,style,aligment)

Specified by:

getTextSymbol in interface ILabelClass

Returns:

label ITextSymbol

setLabelStyle

public void setLabelStyle(ILabelStyle labelStyle)

Description copied from interface: ILabelClass

Stablishes the style for the label.

Specified by:

setLabelStyle in interface ILabelClass

Parameters:

labelStyle - ILabelStyle

setTextSymbol

public void setTextSymbol(ITextSymbol textSymbol)

Description copied from interface: ILabelClass

Stablishes the text symbol that is going to be used for the text(the font,size,style,aligment)

Specified by:

setTextSymbol in interface ILabelClass

Parameters:

textSymbol - ITextSymbol

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

registerPersistent

public static void registerPersistent()

isVisible

public boolean isVisible()

Description copied from interface: ILabelClass

Returns true if the label will be showed in the map

Specified by:

isVisible in interface ILabelClass

Returns:

isVisible boolean

isVisible

public boolean isVisible(double scale)

Description copied from interface: ILabelClass

Returns true if the label will be showed in the map

Specified by:

isVisible in interface ILabelClass

Returns:

isVisible boolean

setVisible

public void setVisible(boolean isVisible)

Description copied from interface: ILabelClass

Sets the visibility of the label in the map.

Specified by:

setVisible in interface ILabelClass

Parameters:

isVisible - boolean

getName

public java.lang.String getName()

Description copied from interface: ILabelClass

Returns the name of the label

Specified by:

getName in interface ILabelClass

setName

public void setName(java.lang.String name)

Description copied from interface: ILabelClass

Stablishes the name of the label

Specified by:

setName in interface ILabelClass

setTexts

public void setTexts(java.lang.String[] texts)

Description copied from interface: ILabelClass

Sets the text for the label

Specified by:

setTexts in interface ILabelClass

Parameters:

texts - String[]

getTexts

public java.lang.String[] getTexts()

Description copied from interface: ILabelClass

Return the text for the label

Specified by:

getTexts in interface ILabelClass

getPriority

public int getPriority()

Specified by:

getPriority in interface ILabelClass

setPriority

public void setPriority(int priority)

Specified by:

setPriority in interface ILabelClass

getShape

public Geometry getShape(ILabelLocationMetrics llm)
                  throws CreateGeometryException

Specified by:

getShape in interface ILabelClass

Throws:

CreateGeometryException

setCartographicContext

public void setCartographicContext(CartographicSupport.CartographicContext ctx)

Specified by:

setCartographicContext in interface CartographicSupport

Overrides:

setCartographicContext in class AbstractCartographicSupport

getBounds

public java.awt.Rectangle getBounds()

Specified by:

getBounds in interface ILabelClass

getSQLQuery

public java.lang.String getSQLQuery()

Specified by:

getSQLQuery in interface ILabelClass

setSQLQuery

public void setSQLQuery(java.lang.String sqlQuery)

Specified by:

setSQLQuery in interface ILabelClass

getLabelExpressions

public java.lang.String[] getLabelExpressions()

Description copied from interface: ILabelClass

Returns the expression that defines the text which will be showed in the label

Specified by:

getLabelExpressions in interface ILabelClass

Returns:

labelExpressions String[]

setLabelExpressions

public void setLabelExpressions(java.lang.String[] lbl_exps)

Description copied from interface: ILabelClass

Sets the expression that defines the text which will be showed in the label

Specified by:

setLabelExpressions in interface ILabelClass

setUseSqlQuery

public void setUseSqlQuery(boolean use_sql)

Specified by:

setUseSqlQuery in interface ILabelClass

isUseSqlQuery

public boolean isUseSqlQuery()

Specified by:

isUseSqlQuery in interface ILabelClass

getStringLabelExpression

public java.lang.String getStringLabelExpression()

Description copied from interface: ILabelClass

Returns the expression that defines the text which will be showed in the label ready to be used for the label parser

Specified by:

getStringLabelExpression in interface ILabelClass

Returns:

labelExpression String

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 java.lang.Object

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