org.gvsig.labeling.label

Class GeneralLabelingStrategy

java.lang.Object

org.gvsig.labeling.label.GeneralLabelingStrategy

All Implemented Interfaces:

Cloneable, ILabelingStrategy, CartographicSupport, Persistent

public class GeneralLabelingStrategy
extends Object
implements ILabelingStrategy, Cloneable, CartographicSupport

Field Summary

Fields

Modifier and Type	Field and Description
static LinePlacementConstraints	DefaultLinePlacementConstraints
static PointPlacementConstraints	DefaultPointPlacementConstraints
static PolygonPlacementConstraints	DefaultPolygonPlacementConstraints
static String	GENERAL_LABEL_STRATEGY_PERSISTENCE_NAME
protected FLyrVect	layer

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

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
GeneralLabelingStrategy()

Method Summary

Modifier and Type	Method and Description
Object	clone()
void	draw(BufferedImage mapImage, Graphics2D mapGraphics, double scale, ViewPort viewPort, Cancellable cancel, double dpi) Causes the labels to be drawn.
double	getCartographicSize(ViewPort vp, 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).
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.
int	getUnit() Returns the unit used to express measures.
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.
boolean	isAllowingOverlap()
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(Graphics2D g, double scale, ViewPort viewPort, Cancellable cancel, PrintAttributes properties) Applies the printer properties to the rendering process to match its attributes.
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAllowOverlapping(boolean allowOverlapping)
void	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
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	setReferenceSystem(int referenceSystem) Sets the Reference System that defines how this units have to be handled.
void	setUnit(int unitIndex) Defines the unit used to express measures.
void	setZoomConstraints(IZoomConstraints constraints) Sets the PlacementConstraints that will determine where to place the labels.
boolean	shouldDrawLabels(double scale)
double	toCartographicSize(ViewPort vp, 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).

Methods inherited from class java.lang.Object

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

Field Detail

GENERAL_LABEL_STRATEGY_PERSISTENCE_NAME

public static final String GENERAL_LABEL_STRATEGY_PERSISTENCE_NAME

See Also:

Constant Field Values

DefaultPointPlacementConstraints

public static PointPlacementConstraints DefaultPointPlacementConstraints

DefaultLinePlacementConstraints

public static LinePlacementConstraints DefaultLinePlacementConstraints

DefaultPolygonPlacementConstraints

public static PolygonPlacementConstraints DefaultPolygonPlacementConstraints

layer

protected FLyrVect layer

Constructor Detail

GeneralLabelingStrategy

public GeneralLabelingStrategy()

Method Detail

setLayer

public void setLayer(FLayer layer)

Specified by:

setLayer in interface ILabelingStrategy

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

draw

public void draw(BufferedImage mapImage,
                 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

isAllowingOverlap

public boolean isAllowingOverlap()

setAllowOverlapping

public void setAllowOverlapping(boolean allowOverlapping)

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

print

public void print(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 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:

shouldDrawLabels

public boolean shouldDrawLabels(double scale)

Specified by:

shouldDrawLabels in interface ILabelingStrategy

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

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

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

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

registerPersistent

public static void registerPersistent()

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

toCartographicSize

public double toCartographicSize(ViewPort vp,
                                 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

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 CartographicSupport

getCartographicSize

public double getCartographicSize(ViewPort vp,
                                  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

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException