org.gvsig.labeling.label

Class GeneralLabelingStrategy

java.lang.Object

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

org.gvsig.labeling.label.GeneralLabelingStrategy

All Implemented Interfaces:

java.lang.Cloneable, ILabelingStrategy, CartographicSupport, IGeneralLabelingStrategy, Persistent

public class GeneralLabelingStrategy
extends AbstractCartographicSupport
implements IGeneralLabelingStrategy

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 LinePlacementConstraints	DefaultLinePlacementConstraints
static PointPlacementConstraints	DefaultPointPlacementConstraints
static PolygonPlacementConstraints	DefaultPolygonPlacementConstraints
static java.lang.String	GENERAL_LABEL_STRATEGY_PERSISTENCE_NAME
protected FLyrVect	layer

Fields inherited from interface org.gvsig.labeling.label.IGeneralLabelingStrategy

NAME

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
java.lang.Object	clone()
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.
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[]	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(java.awt.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	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	setZoomConstraints(IZoomConstraints constraints) Sets the PlacementConstraints that will determine where to place the labels.
boolean	shouldDrawLabels(double scale)

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

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

GENERAL_LABEL_STRATEGY_PERSISTENCE_NAME

public static final java.lang.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(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

isAllowingOverlap

public boolean isAllowingOverlap()

Specified by:

isAllowingOverlap in interface IGeneralLabelingStrategy

setAllowOverlapping

public void setAllowOverlapping(boolean allowOverlapping)

Specified by:

setAllowOverlapping in interface IGeneralLabelingStrategy

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(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:

shouldDrawLabels

public boolean shouldDrawLabels(double scale)

Specified by:

shouldDrawLabels in interface ILabelingStrategy

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

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException