org.gvsig.symbology.fmap.mapcontext.rendering.dynamiclegend

Class DefaultDynamicLabelingStrategy

java.lang.Object

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

org.gvsig.symbology.fmap.mapcontext.rendering.dynamiclegend.DefaultDynamicLabelingStrategy

All Implemented Interfaces:

ILabelingStrategy, CartographicSupport, DynamicLabelingStrategy, Persistent

public class DefaultDynamicLabelingStrategy
extends AbstractCartographicSupport
implements DynamicLabelingStrategy

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 Expression	expColor
static Expression	expFont
static Expression	expFontStyle
static Expression	expHeight
static Expression	expReferenceSystem
static Expression	expRotation
static Expression	expText
static Expression	expUnit
java.lang.String	LCOLOR
java.lang.String	LFONT
java.lang.String	LFONTSTYLE
java.lang.String	LHEIGHT
java.lang.String	LROTATION
java.lang.String	LTEXT

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.dynamiclegend.DynamicLabelingStrategy

NAME

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

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
DefaultDynamicLabelingStrategy()

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.image.BufferedImage mapImage, java.awt.Graphics2D mapGraphics, double scale, ViewPort viewPort, Cancellable cancel, double dpi) Causes the labels to be drawn.
Expression	getColor()
Expression	getColorFont()
java.awt.Color	getComputedColor()
java.awt.Color	getComputedColorFont()
java.awt.Color	getComputedFixedColor()
double	getComputedFixedSize()
java.awt.Font	getComputedFont()
int	getComputedFontStyle()
int	getComputedHeight()
int	getComputedReferenceSystem()
int	getComputedRotation()
java.lang.String	getComputedText()
int	getComputedUnit()
int	getComputedUnitExp()
java.lang.Object	getComputedValue(java.lang.String field)
SymbolTable	getFeatureSymbolTable()
Expression	getFixedColor()
Expression	getFixedSize()
Expression	getFont()
Expression	getFontStyle()
Expression	getHeight()
ILabelingMethod	getLabelingMethod() Returns the labeling method currently in use.
IPlacementConstraints	getPlacementConstraints() Returns the current placement constraints that determine the position where the label is placed.
int	getReferenceSystem() Returns the Reference System used to draw the elements of the image.
Expression	getReferenceSystemExp()
Expression	getRotation()
Expression	getText()
int	getUnit() Returns the unit used to express measures.
Expression	getUnitExp()
java.lang.String[]	getUsedFields() Returns a non-null String[] containing the names of the fields involved in the labeling.
IZoomConstraints	getZoomConstraints() Returns the current placement constraints that determine the position where the label is placed.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(java.awt.Graphics2D g, double scale, ViewPort viewPort, Cancellable cancel, PrintAttributes properties) Applies the printer properties to the rendering process to match its attributes.
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setColor(Expression expression)
void	setColorFont(java.awt.Color colorFont)
void	setFeature(Feature f)
void	setFixedColor(java.awt.Color fixedColor)
void	setFixedSize(double fixedSize)
void	setFont(Expression expression)
void	setFont(java.awt.Font selFont)
void	setFontStyle(Expression expression)
void	setFontStyle(int style)
void	setHeight(Expression expression)
void	setLabelingMethod(ILabelingMethod method) Sets the labeling method that will be used the next time the the draw is invoked.
void	setLayer(FLayer flayer)
void	setPlacementConstraints(IPlacementConstraints constraints) Sets the PlacementConstraints that will determine where to place the labels.
void	setReferenceSystem(Expression expression)
void	setReferenceSystem(int referenceSystem) Sets the Reference System that defines how this units have to be handled.
void	setRotation(Expression expression)
void	setText(Expression expression)
void	setUnit(Expression expression)
void	setUnit(int unitIndex) Defines the unit used to express measures.
void	setUsesFixedColor(boolean b)
void	setUsesFixedSize(boolean b)
void	setZoomConstraints(IZoomConstraints constraints) Sets the PlacementConstraints that will determine where to place the labels.
boolean	shouldDrawLabels(double scale)
boolean	usesFixedColor()
boolean	usesFixedSize()

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

copyCartographicContext, getCartographicContext, isInPixels, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, toCartographicUnits

Methods inherited from class java.lang.Object

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

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

copyCartographicContext, copyCartographicContext, getCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, toCartographicUnits

Field Detail

LROTATION

public java.lang.String LROTATION

LTEXT

public java.lang.String LTEXT

LHEIGHT

public java.lang.String LHEIGHT

LCOLOR

public java.lang.String LCOLOR

LFONT

public java.lang.String LFONT

LFONTSTYLE

public java.lang.String LFONTSTYLE

expRotation

public static Expression expRotation

expText

public static Expression expText

expHeight

public static Expression expHeight

expColor

public static Expression expColor

expFont

public static Expression expFont

expFontStyle

public static Expression expFontStyle

expUnit

public static Expression expUnit

expReferenceSystem

public static Expression expReferenceSystem

Constructor Detail

DefaultDynamicLabelingStrategy

public DefaultDynamicLabelingStrategy()

Method Detail

getFeatureSymbolTable

public SymbolTable getFeatureSymbolTable()

getComputedValue

public java.lang.Object getComputedValue(java.lang.String field)

getRotation

public Expression getRotation()

Specified by:

getRotation in interface DynamicLabelingStrategy

getComputedRotation

public int getComputedRotation()

Specified by:

getComputedRotation in interface DynamicLabelingStrategy

getText

public Expression getText()

Specified by:

getText in interface DynamicLabelingStrategy

getComputedText

public java.lang.String getComputedText()

Specified by:

getComputedText in interface DynamicLabelingStrategy

getHeight

public Expression getHeight()

Specified by:

getHeight in interface DynamicLabelingStrategy

getComputedHeight

public int getComputedHeight()

Specified by:

getComputedHeight in interface DynamicLabelingStrategy

getColor

public Expression getColor()

Specified by:

getColor in interface DynamicLabelingStrategy

getComputedColor

public java.awt.Color getComputedColor()

Specified by:

getComputedColor in interface DynamicLabelingStrategy

getFixedSize

public Expression getFixedSize()

Specified by:

getFixedSize in interface DynamicLabelingStrategy

getComputedFixedSize

public double getComputedFixedSize()

Specified by:

getComputedFixedSize in interface DynamicLabelingStrategy

getComputedUnit

public int getComputedUnit()

Specified by:

getComputedUnit in interface DynamicLabelingStrategy

setText

public void setText(Expression expression)

Specified by:

setText in interface DynamicLabelingStrategy

setRotation

public void setRotation(Expression expression)

Specified by:

setRotation in interface DynamicLabelingStrategy

setHeight

public void setHeight(Expression expression)

Specified by:

setHeight in interface DynamicLabelingStrategy

setColor

public void setColor(Expression expression)

Specified by:

setColor in interface DynamicLabelingStrategy

setUsesFixedSize

public void setUsesFixedSize(boolean b)

Specified by:

setUsesFixedSize in interface DynamicLabelingStrategy

usesFixedSize

public boolean usesFixedSize()

Specified by:

usesFixedSize in interface DynamicLabelingStrategy

setFixedSize

public void setFixedSize(double fixedSize)

Specified by:

setFixedSize in interface DynamicLabelingStrategy

setUsesFixedColor

public void setUsesFixedColor(boolean b)

Specified by:

setUsesFixedColor in interface DynamicLabelingStrategy

usesFixedColor

public boolean usesFixedColor()

Specified by:

usesFixedColor in interface DynamicLabelingStrategy

getFixedColor

public Expression getFixedColor()

Specified by:

getFixedColor in interface DynamicLabelingStrategy

getComputedFixedColor

public java.awt.Color getComputedFixedColor()

Specified by:

getComputedFixedColor in interface DynamicLabelingStrategy

setFixedColor

public void setFixedColor(java.awt.Color fixedColor)

Specified by:

setFixedColor in interface DynamicLabelingStrategy

getColorFont

public Expression getColorFont()

Specified by:

getColorFont in interface DynamicLabelingStrategy

getComputedColorFont

public java.awt.Color getComputedColorFont()

Specified by:

getComputedColorFont in interface DynamicLabelingStrategy

setColorFont

public void setColorFont(java.awt.Color colorFont)

Specified by:

setColorFont in interface DynamicLabelingStrategy

getFont

public Expression getFont()

Specified by:

getFont in interface DynamicLabelingStrategy

getComputedFont

public java.awt.Font getComputedFont()

Specified by:

getComputedFont in interface DynamicLabelingStrategy

setFont

public void setFont(java.awt.Font selFont)

Specified by:

setFont in interface DynamicLabelingStrategy

getFontStyle

public Expression getFontStyle()

Specified by:

getFontStyle in interface DynamicLabelingStrategy

getComputedFontStyle

public int getComputedFontStyle()

Specified by:

getComputedFontStyle in interface DynamicLabelingStrategy

setFontStyle

public void setFontStyle(Expression expression)

Specified by:

setFontStyle in interface DynamicLabelingStrategy

setFeature

public void setFeature(Feature f)

Specified by:

setFeature in interface DynamicLabelingStrategy

getLabelingMethod

public ILabelingMethod getLabelingMethod()

Description copied from interface: ILabelingStrategy

Returns the labeling method currently in use. The labeling method handles a list of LabelClass that allows to handle several definition of labels in the layer.

Specified by:

getLabelingMethod in interface ILabelingStrategy

Returns:

ILabelingMethod, the current one.

See Also:

ILabelingMethod

setLabelingMethod

public void setLabelingMethod(ILabelingMethod method)

Description copied from interface: ILabelingStrategy

Sets the labeling method that will be used the next time the the draw is invoked.

Specified by:

setLabelingMethod in interface ILabelingStrategy

getPlacementConstraints

public IPlacementConstraints getPlacementConstraints()

Description copied from interface: ILabelingStrategy

Returns the current placement constraints that determine the position where the label is placed.

Specified by:

getPlacementConstraints in interface ILabelingStrategy

Returns:

setPlacementConstraints

public void setPlacementConstraints(IPlacementConstraints constraints)

Description copied from interface: ILabelingStrategy

Sets the PlacementConstraints that will determine where to place the labels. The change will take effect next time the draw(...) method is invoked.

Specified by:

setPlacementConstraints in interface ILabelingStrategy

getZoomConstraints

public IZoomConstraints getZoomConstraints()

Description copied from interface: ILabelingStrategy

Returns the current placement constraints that determine the position where the label is placed.

Specified by:

getZoomConstraints in interface ILabelingStrategy

Returns:

setZoomConstraints

public void setZoomConstraints(IZoomConstraints constraints)

Description copied from interface: ILabelingStrategy

Sets the PlacementConstraints that will determine where to place the labels. The change will take effect next time the draw(...) method is invoked.

Specified by:

setZoomConstraints in interface ILabelingStrategy

getUnitExp

public Expression getUnitExp()

Specified by:

getUnitExp in interface DynamicLabelingStrategy

getReferenceSystemExp

public Expression getReferenceSystemExp()

draw

public void draw(java.awt.image.BufferedImage mapImage,
                 java.awt.Graphics2D mapGraphics,
                 double scale,
                 ViewPort viewPort,
                 Cancellable cancel,
                 double dpi)
          throws ReadException

Description copied from interface: ILabelingStrategy

Causes the labels to be drawn. The policy of process is determined by the LabelingStrategy previously set.

Specified by:

draw in interface ILabelingStrategy

dpi - TODO

Throws:

ReadException

print

public void print(java.awt.Graphics2D g,
                  double scale,
                  ViewPort viewPort,
                  Cancellable cancel,
                  PrintAttributes properties)
           throws ReadException

Description copied from interface: ILabelingStrategy

Applies the printer properties to the rendering process to match its attributes. The result is manifested in the Graphics2D g which is the object sent to the printer.

Specified by:

print in interface ILabelingStrategy

Throws:

ReadException

getUsedFields

public java.lang.String[] getUsedFields()

Description copied from interface: ILabelingStrategy

Returns a non-null String[] containing the names of the fields involved in the labeling. If this strategy contains more than one LabelClass the result is an array with all the names of the fields used by all the LabelClass, with no duplicates.

Specified by:

getUsedFields in interface ILabelingStrategy

Returns:

setLayer

public void setLayer(FLayer flayer)

Specified by:

setLayer in interface ILabelingStrategy

shouldDrawLabels

public boolean shouldDrawLabels(double scale)

Specified by:

shouldDrawLabels in interface ILabelingStrategy

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

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

Overrides:

setUnit in class AbstractCartographicSupport

setUnit

public void setUnit(Expression expression)

Specified by:

setUnit in interface DynamicLabelingStrategy

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

Overrides:

getUnit in class AbstractCartographicSupport

getComputedUnitExp

public int getComputedUnitExp()

getComputedReferenceSystem

public int getComputedReferenceSystem()

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

Overrides:

getReferenceSystem in class AbstractCartographicSupport

Returns:

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 CartographicSupport

Overrides:

setReferenceSystem in class AbstractCartographicSupport

setFont

public void setFont(Expression expression)

Specified by:

setFont in interface DynamicLabelingStrategy

setFontStyle

public void setFontStyle(int style)

Specified by:

setFontStyle in interface DynamicLabelingStrategy

setReferenceSystem

public void setReferenceSystem(Expression expression)

Specified by:

setReferenceSystem in interface DynamicLabelingStrategy