org.gvsig.fmap.mapcontext.rendering.legend.styling

Interface ILabelClass

All Superinterfaces:

CartographicSupport, java.lang.Cloneable, Persistent

All Known Subinterfaces:

ComplexLabelClass

All Known Implementing Classes:

DefaultComplexLabelClass, LabelClass, SmartTextSymbolLabelClass

public interface ILabelClass
extends Cloneable, Persistent, CartographicSupport

Nested Class Summary

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

CartographicSupport.CartographicContext

Field Summary

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

PAPER, WORLD

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics2D graphics, ILabelLocationMetrics llm, Geometry geom) 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	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.
java.lang.String	toString()

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

clone, cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

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

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

Method Detail

isVisible

boolean isVisible()

Returns true if the label will be showed in the map

Returns:

isVisible boolean

isVisible

boolean isVisible(double scale)

Returns true if the label will be showed in the map

Returns:

isVisible boolean

setVisible

void setVisible(boolean isVisible)

Sets the visibility of the label in the map.

Parameters:

isVisible - boolean

getTextSymbol

ITextSymbol getTextSymbol()

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

Returns:

label ITextSymbol

setTextSymbol

void setTextSymbol(ITextSymbol textSymbol)

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

Parameters:

textSymbol - ITextSymbol

setLabelStyle

void setLabelStyle(ILabelStyle labelStyle)

Stablishes the style for the label.

Parameters:

labelStyle - ILabelStyle

getLabelStyle

ILabelStyle getLabelStyle()

Returns the style of the label

getName

java.lang.String getName()

Returns the name of the label

setName

void setName(java.lang.String name)

Stablishes the name of the label

Parameters:

name -

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

setTexts

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

Sets the text for the label

Parameters:

texts - String[]

getTexts

java.lang.String[] getTexts()

Return the text for the label

Parameters:

texts - String[]

draw

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

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

Parameters:

graphics, - graphics to use to paint the label.

llm, - concrete settings of the placement of this layer

shp, - the Shape over whose the label is painted

drawInsideRectangle

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

Useful to render a Label with size inside little rectangles.

Parameters:

graphics - Graphics2D

bounds - Rectangle

Throws:

SymbolDrawingException

getPriority

int getPriority()

setPriority

void setPriority(int priority)

getShape

Geometry getShape(ILabelLocationMetrics llm)
           throws CreateGeometryException

Throws:

CreateGeometryException

getClassName

java.lang.String getClassName()

getBounds

java.awt.Rectangle getBounds()

getSQLQuery

java.lang.String getSQLQuery()

setSQLQuery

void setSQLQuery(java.lang.String sqlQuery)

getLabelExpressions

java.lang.String[] getLabelExpressions()

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

Returns:

labelExpressions String[]

setLabelExpressions

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

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

setUseSqlQuery

void setUseSqlQuery(boolean use_sql)

isUseSqlQuery

boolean isUseSqlQuery()

getStringLabelExpression

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

Returns:

labelExpression String