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

Class AttrInTableLabelingStrategy

java.lang.Object

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

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

All Implemented Interfaces:

ILabelingStrategy, CartographicSupport, IAttrInTableLabelingStrategy, Persistent

public class AttrInTableLabelingStrategy
extends AbstractCartographicSupport
implements IAttrInTableLabelingStrategy

LabelingStrategy used when the user wants to use label sizes, rotations, etc. from the values included in fields of the datasource's table

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttrInTableLabelingStrategy.RegisterPersistence

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 double	MIN_TEXT_SIZE

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.legend.styling.IAttrInTableLabelingStrategy

NAME

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

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
AttrInTableLabelingStrategy()

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, double scale, ViewPort viewPort, Cancellable cancel, double dpi) Causes the labels to be drawn.
java.lang.String	getColorField()
java.awt.Color	getColorFont()
java.awt.Color	getFixedColor()
double	getFixedSize()
java.awt.Font	getFont()
java.lang.String	getHeightField()
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.
java.lang.String	getRotationField()
java.lang.String	getTextField()
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 props) 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	setColorField(java.lang.String colorFieldName)
void	setColorFont(java.awt.Color colorFont)
void	setFixedColor(java.awt.Color fixedColor)
void	setFixedSize(double fixedSize)
void	setFont(java.awt.Font selFont)
void	setHeightField(java.lang.String heightFieldName) Sets the field that contains the size of the text.
void	setLabelingMethod(ILabelingMethod method) Sets the labeling method that will be used the next time the the draw is invoked.
void	setLayer(FLayer layer)
void	setPlacementConstraints(IPlacementConstraints constraints) Sets the PlacementConstraints that will determine where to place the labels.
void	setRotationField(java.lang.String rotationFieldName)
void	setTextField(java.lang.String textFieldName)
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, getReferenceSystem, getUnit, isInPixels, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setReferenceSystem, setUnit, 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, getReferenceSystem, getUnit, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setCartographicContext, setReferenceSystem, setUnit, toCartographicUnits

Field Detail

MIN_TEXT_SIZE

public static final double MIN_TEXT_SIZE

See Also:

Constant Field Values

Constructor Detail

AttrInTableLabelingStrategy

public AttrInTableLabelingStrategy()

Method Detail

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

draw

public void draw(java.awt.image.BufferedImage image,
                 java.awt.Graphics2D g,
                 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

getRotationField

public java.lang.String getRotationField()

Specified by:

getRotationField in interface IAttrInTableLabelingStrategy

getTextField

public java.lang.String getTextField()

Specified by:

getTextField in interface IAttrInTableLabelingStrategy

getHeightField

public java.lang.String getHeightField()

Specified by:

getHeightField in interface IAttrInTableLabelingStrategy

getColorField

public java.lang.String getColorField()

Specified by:

getColorField in interface IAttrInTableLabelingStrategy

setTextField

public void setTextField(java.lang.String textFieldName)

Specified by:

setTextField in interface IAttrInTableLabelingStrategy

setRotationField

public void setRotationField(java.lang.String rotationFieldName)

Specified by:

setRotationField in interface IAttrInTableLabelingStrategy

setHeightField

public void setHeightField(java.lang.String heightFieldName)

Sets the field that contains the size of the text. The size is computed in meters. To use any other unit, call setUnit(int) with the scale factor from meters (for centimeters, call setUnitFactor(0.01)).

Specified by:

setHeightField in interface IAttrInTableLabelingStrategy

Parameters:

heightFieldName -

setColorField

public void setColorField(java.lang.String colorFieldName)

Specified by:

setColorField in interface IAttrInTableLabelingStrategy

print

public void print(java.awt.Graphics2D g,
                  double scale,
                  ViewPort viewPort,
                  Cancellable cancel,
                  PrintAttributes props)
           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

setUsesFixedSize

public void setUsesFixedSize(boolean b)

Specified by:

setUsesFixedSize in interface IAttrInTableLabelingStrategy

usesFixedSize

public boolean usesFixedSize()

Specified by:

usesFixedSize in interface IAttrInTableLabelingStrategy

getFixedSize

public double getFixedSize()

Specified by:

getFixedSize in interface IAttrInTableLabelingStrategy

setFixedSize

public void setFixedSize(double fixedSize)

Specified by:

setFixedSize in interface IAttrInTableLabelingStrategy

setUsesFixedColor

public void setUsesFixedColor(boolean b)

Specified by:

setUsesFixedColor in interface IAttrInTableLabelingStrategy

usesFixedColor

public boolean usesFixedColor()

Specified by:

usesFixedColor in interface IAttrInTableLabelingStrategy

getFixedColor

public java.awt.Color getFixedColor()

Specified by:

getFixedColor in interface IAttrInTableLabelingStrategy

setFixedColor

public void setFixedColor(java.awt.Color fixedColor)

Specified by:

setFixedColor in interface IAttrInTableLabelingStrategy

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 layer)

Specified by:

setLayer in interface ILabelingStrategy

shouldDrawLabels

public boolean shouldDrawLabels(double scale)

Specified by:

shouldDrawLabels in interface ILabelingStrategy

getColorFont

public java.awt.Color getColorFont()

Specified by:

getColorFont in interface IAttrInTableLabelingStrategy

setColorFont

public void setColorFont(java.awt.Color colorFont)

Specified by:

setColorFont in interface IAttrInTableLabelingStrategy

getFont

public java.awt.Font getFont()

Specified by:

getFont in interface IAttrInTableLabelingStrategy

setFont

public void setFont(java.awt.Font selFont)

Specified by:

setFont in interface IAttrInTableLabelingStrategy

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