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

Class LabelClass

java.lang.Object

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

All Implemented Interfaces:

Cloneable, ILabelClass, CartographicSupport, Persistent

Direct Known Subclasses:

DefaultComplexLabelClass

public class LabelClass
extends Object
implements ILabelClass

LabelClass is the model of the label in the new simbology of gvSIG. In this class is contained its definition, the expresion that defines the text which is going to be showed, if it will be visible or not, the text symbol that is going to paint the label and the style for its background.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelClass.RegisterPersistence

Field Summary

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

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
LabelClass()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Creates a copy of the object.
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	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setLabelExpressions(String[] lbl_exps) Stablishes the expresion that, when it is evaluated, returns the text which will be showed by 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 class java.lang.Object

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

Constructor Detail

LabelClass

public LabelClass()

Method Detail

isVisible

public boolean isVisible()

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)

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)

Sets the visibility of the label in the map.

Specified by:

setVisible in interface ILabelClass

Parameters:

isVisible - boolean

getLabelExpressions

public String[] getLabelExpressions()

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

Specified by:

getLabelExpressions in interface ILabelClass

Returns:

labelExpression String

setLabelExpressions

public void setLabelExpressions(String[] lbl_exps)

Stablishes the expresion that, when it is evaluated, returns the text which will be showed by the label.

Specified by:

setLabelExpressions in interface ILabelClass

Parameters:

labelExpression - String

getTextSymbol

public ITextSymbol getTextSymbol()

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

setTextSymbol

public void setTextSymbol(ITextSymbol textSymbol)

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

setLabelStyle

public void setLabelStyle(ILabelStyle labelStyle)

Stablishes the style for the label.

Specified by:

setLabelStyle in interface ILabelClass

Parameters:

labelStyle - ILabelStyle

getLabelStyle

public ILabelStyle getLabelStyle()

Returns the style of the label

Specified by:

getLabelStyle in interface ILabelClass

getName

public String getName()

Returns the name of the label

Specified by:

getName in interface ILabelClass

setName

public void setName(String name)

Stablishes the name of the label

Specified by:

setName in interface ILabelClass

Parameters:

name -

toString

public String toString()

Specified by:

toString in interface ILabelClass

Overrides:

toString in class Object

setTexts

public void setTexts(String[] texts)

Sets the text for the label

Specified by:

setTexts in interface ILabelClass

Parameters:

texts - String[]

getTexts

public String[] getTexts()

Return the text for the label

Specified by:

getTexts in interface ILabelClass

Parameters:

texts - String[]

draw

public 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

Specified by:

draw in interface ILabelClass

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

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

Useful to render a Label with size inside little rectangles.

Specified by:

drawInsideRectangle in interface ILabelClass

Parameters:

graphics - Graphics2D

bounds - Rectangle

Throws:

SymbolDrawingException

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

getClassName

public String getClassName()

Specified by:

getClassName in interface ILabelClass

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 ILabelClass

Specified by:

getCartographicSize in interface CartographicSupport

Returns:

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

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 ILabelClass

Specified by:

getReferenceSystem in interface CartographicSupport

Returns:

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 ILabelClass

Specified by:

getUnit 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 ILabelClass

Specified by:

setCartographicSize in interface CartographicSupport

setReferenceSystem

public 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 ILabelClass

Specified by:

setReferenceSystem in interface CartographicSupport

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 ILabelClass

Specified by:

setUnit 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 ILabelClass

Specified by:

toCartographicSize in interface CartographicSupport

Returns:

a double containing the previous defined size

getBounds

public Rectangle getBounds()

Specified by:

getBounds in interface ILabelClass

getSQLQuery

public String getSQLQuery()

Specified by:

getSQLQuery in interface ILabelClass

setSQLQuery

public void setSQLQuery(String sqlQuery)

Specified by:

setSQLQuery in interface ILabelClass

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

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

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