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

Interface ILabelClass

All Superinterfaces:

CartographicSupport, Cloneable, Persistent

All Known Subinterfaces:

ComplexLabelClass

All Known Implementing Classes:

DefaultComplexLabelClass, LabelClass, SmartTextSymbolLabelClass

public interface ILabelClass
extends Cloneable, Persistent, CartographicSupport

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(Graphics2D graphics, ILabelLocationMetrics llm, Geometry geom) LabelLocationMetrics, contains the anchor point, rotation, and some other geometric calculations computed by the PlacementManager.
void	drawInsideRectangle(Graphics2D graphics, Rectangle bounds) Useful to render a Label with size 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).
String	getClassName()
String[]	getLabelExpressions() Returns the expression that defines the text which will be showed in the label
ILabelStyle	getLabelStyle() Returns the style of the label
String	getName() Returns the name of the label
int	getPriority()
int	getReferenceSystem() Returns the Reference System used to draw the elements of the image.
Geometry	getShape(ILabelLocationMetrics llm)
String	getSQLQuery()
String	getStringLabelExpression() Returns the expression that defines the text which will be showed in the label ready to be used for the label parser
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)
int	getUnit() Returns the unit used to express measures.
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	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setLabelExpressions(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(String name) Stablishes the name of the label
void	setPriority(int priority)
void	setReferenceSystem(int referenceSystem) Sets the Reference System that defines how this units have to be handled.
void	setSQLQuery(String sqlQuery)
void	setTexts(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	setUnit(int unitIndex) Defines the unit used to express measures.
void	setUseSqlQuery(boolean use_sql)
void	setVisible(boolean isVisible) Sets the visibility of the label in the map.
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).
String	toString()

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

clone

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

loadFromState, saveToState

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

String getName()

Returns the name of the label

setName

void setName(String name)

Stablishes the name of the label

Parameters:

name -

toString

String toString()

Overrides:

toString in class Object

setTexts

void setTexts(String[] texts)

Sets the text for the label

Parameters:

texts - String[]

getTexts

String[] getTexts()

Return the text for the label

Parameters:

texts - String[]

draw

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

String getClassName()

getCartographicSize

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

getReferenceSystem

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:

getUnit

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

setCartographicSize

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

setReferenceSystem

void setReferenceSystem(int referenceSystem)

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

setUnit

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

toCartographicSize

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

getBounds

Rectangle getBounds()

getSQLQuery

String getSQLQuery()

setSQLQuery

void setSQLQuery(String sqlQuery)

getLabelExpressions

String[] getLabelExpressions()

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

Returns:

labelExpressions String[]

setLabelExpressions

void setLabelExpressions(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

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