com.luciad.view.gxy

LuciadLightspeedClass TLcdGXYLayerLabelPainter

java.lang.Object

com.luciad.view.gxy.TLcdGXYLayerLabelPainter

All Implemented Interfaces:

ILcdCloneable, ILcdGXYLayerLabelPainter , Cloneable

public class TLcdGXYLayerLabelPainter
extends Object
implements 
ILcdGXYLayerLabelPainter
, ILcdCloneable

A greedy layer label painter based on the label locations provided by each label's label painter. It tries to place all labels one by one, and when a label cannot be placed without overlap, it is omitted. If a sublabel of a label is dropped, all the sublabels of that label are dropped.

The user can control the quality versus the labeling speed through the properties fineTuning, overLappingAllowed and allowedCluttering.

Note that this painter does not know of a layer's TLcdGXYLayer.setSelectionLabeled(boolean) property. See setSelectionLabeled(boolean) instead.

For other labeling algorithms, see ILcdGXYViewLabelPlacer.

See Also:

ILcdGXYViewLabelPlacer, TLcdGXYLabelPainterLocationLabelingAlgorithm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdGXYLayerLabelPainter.Quality

Field Summary

Fields

Modifier and Type	Field and Description
static TLcdGXYLayerLabelPainter.Quality	HIGH
static TLcdGXYLayerLabelPainter.Quality	LOW

Fields inherited from interface com.luciad.view.gxy.ILcdGXYLayerLabelPainter

ALL, SELECTION

Constructor Summary

Constructors

Constructor and Description
TLcdGXYLayerLabelPainter()
TLcdGXYLayerLabelPainter(TLcdGXYLayerLabelPainter aGXYLayerLabelPainter)

Method Summary

Modifier and Type	Method and Description
Object	clone() Redefines Object.clone to make it public.
double	getAllowedCluttering() allowedCluttering defines the fraction (a double located between 0 and 1 ) of the area (pixels) that the labels may occupy.
int	getForcedPaintingThresholdPriority() Returns the threshold priority for forced label painting.
ILcdGXYLabelPriorityProvider	getLabelPriorityProvider() Returns the ILcdGXYLabelPriorityProvider that is used by this label painter.
TLcdGXYLayerLabelPainter.Quality	getQuality() Returns the quality of the placement of the labels.
void	invalidate() Invalidate any stored information about label locations in order to recalculate the label positions.
boolean	isFineTuning() fineTuning determines whether to apply fine grain (thus more time consuming) label placement algorithms.
boolean	isReusePreviousLocation() Deprecated. Use a layer implementing ILcdGXYEditableLabelsLayer instead. ALcdLabelLocations is more flexible and its default implementation automatically removes locations for removed objects.
boolean	isSelectionLabeled()
boolean	isSomewhatOverlapping() somewhatOverlapping determines whether the labels may overlap a bit, thus allowing for more labels to be placed.
void	paintLabel(Graphics aGraphics, ILcdGXYLayer aGXYLayer, ILcdGXYView aGXYView, int aLayerLabelPainterMode) This method shall try to paint the labels of all the objects of all layers in the given ILcdGXYView, in the given mode aMode, considering the aGXYContext.
void	setAllowedCluttering(double aCluttering) allowedCluttering defines the fraction (a double located between 0 and 1 ) of the area (pixels) that the labels may occupy.
void	setFineTuning(boolean aFineTune) fineTuning determines whether to apply fine grain (thus more time consuming) label placement algorithms.
void	setForcedPaintingThresholdPriority(int aPriority) Sets the threshold priority for forced label painting.
void	setLabelPriorityProvider(ILcdGXYLabelPriorityProvider aLabelPriorityProvider) Sets the ILcdGXYLabelPriorityProvider to be used by this label painter.
void	setQuality(TLcdGXYLayerLabelPainter.Quality aQuality) Sets the quality of the algorithm to place the labels.
void	setReusePreviousLocation(boolean aReusePreviousLocation) Deprecated. Use a layer implementing ILcdGXYEditableLabelsLayer instead. ALcdLabelLocations is more flexible and its default implementation automatically removes locations for removed objects.
void	setSelectionLabeled(boolean aSelectionLabeled) selectionLabeled determines whether an object should be labeled anyhow.
void	setSomewhatOverlapping(boolean aOverlap) somewhatOverlapping determines whether the labels may overlap a bit, thus allowing for more labels to be placed.

Methods inherited from class java.lang.Object

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

Field Detail

LOW

public static final TLcdGXYLayerLabelPainter.Quality LOW

HIGH

public static final TLcdGXYLayerLabelPainter.Quality HIGH

Constructor Detail

TLcdGXYLayerLabelPainter

public TLcdGXYLayerLabelPainter()

TLcdGXYLayerLabelPainter

public TLcdGXYLayerLabelPainter(TLcdGXYLayerLabelPainter aGXYLayerLabelPainter)

Method Detail

getQuality

public TLcdGXYLayerLabelPainter.Quality getQuality()

Returns the quality of the placement of the labels. Can be either LOW or HIGH.

Returns:

the quality of the placement of the labels. Can be either LOW or HIGH.

See Also:

setQuality(com.luciad.view.gxy.TLcdGXYLayerLabelPainter.Quality)

setQuality

public void setQuality(TLcdGXYLayerLabelPainter.Quality aQuality)

Sets the quality of the algorithm to place the labels. Accepted values are LOW and HIGH. The HIGH quality algorithm will place more labels without overlapping, while the LOW quality algorithm is faster. The default value is LOW.

Parameters:

aQuality - LOW or HIGH

See Also:

getQuality()

paintLabel

public void paintLabel(Graphics aGraphics,
                       ILcdGXYLayer aGXYLayer,
                       ILcdGXYView aGXYView,
                       int aLayerLabelPainterMode)

This method shall try to paint the labels of all the objects of all layers in the given ILcdGXYView, in the given mode aMode, considering the aGXYContext.

Specified by:

paintLabel in interface ILcdGXYLayerLabelPainter

Parameters:

aGraphics - The Graphics instance on which to paint the labels.

aGXYLayer - The layer for which to paint the labels. If this layer is an instance of ILcdGXYEditableLabelsLayer, its ALcdLabelLocations should be informed of which labels have been drawn and which haven't.

aGXYView - The view in which the layer is contained.

aLayerLabelPainterMode - Determines which labels should be painted. Should be one of ILcdGXYLayerLabelPainter.ALL or ILcdGXYLayerLabelPainter.SELECTION

See Also:

ILcdGXYEditableLabelsLayer, ALcdLabelLocations.setPainted(java.lang.Object, int, int, com.luciad.view.ILcdView, boolean, int)

isFineTuning

public boolean isFineTuning()

fineTuning determines whether to apply fine grain (thus more time consuming) label placement algorithms.

Returns:

true if fineTuning is true, else false is returned.

setFineTuning

public void setFineTuning(boolean aFineTune)

fineTuning determines whether to apply fine grain (thus more time consuming) label placement algorithms. Sets fineTuning to aFineTune.

isSomewhatOverlapping

public boolean isSomewhatOverlapping()

somewhatOverlapping determines whether the labels may overlap a bit, thus allowing for more labels to be placed. The amount of overlap depends on the width and the height of the label. It varies between a few percent to up to twenty percent of the surface of the label.

Returns:

true if somewhatOverlapping is true, else false is returned.

setSomewhatOverlapping

public void setSomewhatOverlapping(boolean aOverlap)

somewhatOverlapping determines whether the labels may overlap a bit, thus allowing for more labels to be placed. The amount of overlap depends on the width and the height of the label. It varies between a few percent to up to twenty percent of the surface of the label. Sets somewhatOverlapping to aOverlap.

getAllowedCluttering

public double getAllowedCluttering()

allowedCluttering defines the fraction (a double located between 0 and 1 ) of the area (pixels) that the labels may occupy. allowedCluttering equal to zero means no labels may be drawn. allowedCluttering equal to one allows the view to be filled by labels.

Returns:

allowedCluttering.

setAllowedCluttering

public void setAllowedCluttering(double aCluttering)

allowedCluttering defines the fraction (a double located between 0 and 1 ) of the area (pixels) that the labels may occupy. allowedCluttering equal to zero means no labels may be drawn. allowedCluttering equal to one allows the view to be filled by labels. Sets allowedCluttering to aCluttering.

setReusePreviousLocation

public void setReusePreviousLocation(boolean aReusePreviousLocation)

Deprecated. Use a layer implementing ILcdGXYEditableLabelsLayer instead. ALcdLabelLocations is more flexible and its default implementation automatically removes locations for removed objects.

reusePreviousLocation determines whether the same relative location for a label should be used if there is one available. Note:previous locations are cached for objects, without reference to the objects model. Therefor if an object is removed from the model, the view label painter is not notified automatically. Use the method invalidate() to clear the cached positions of all objects.

Parameters:

aReusePreviousLocation - true to cache relative label position.

See Also:

isReusePreviousLocation(), invalidate()

isReusePreviousLocation

public boolean isReusePreviousLocation()

Deprecated. Use a layer implementing ILcdGXYEditableLabelsLayer instead. ALcdLabelLocations is more flexible and its default implementation automatically removes locations for removed objects.

Returns whether relative positions for labels were cached.

Returns:

true if relative positions for labels were cached.

See Also:

setReusePreviousLocation(boolean)

setSelectionLabeled

public void setSelectionLabeled(boolean aSelectionLabeled)

selectionLabeled determines whether an object should be labeled anyhow. If false, an object will be labeled in selected mode only if it has a location in default mode. If true, a selected object will always be labeled even if this would cause overlap. should be used if there is one available.

isSelectionLabeled

public boolean isSelectionLabeled()

See Also:

setSelectionLabeled(boolean)

setLabelPriorityProvider

public void setLabelPriorityProvider(ILcdGXYLabelPriorityProvider aLabelPriorityProvider)

Sets the ILcdGXYLabelPriorityProvider to be used by this label painter. If null, no priorities will be used (default behavior).

Parameters:

aLabelPriorityProvider - the ILcdGXYLabelPriorityProvider to be used.

See Also:

getLabelPriorityProvider()

getLabelPriorityProvider

public ILcdGXYLabelPriorityProvider getLabelPriorityProvider()

Returns the ILcdGXYLabelPriorityProvider that is used by this label painter.

Returns:

the ILcdGXYLabelPriorityProvider that is used.

See Also:

setLabelPriorityProvider(ILcdGXYLabelPriorityProvider)

setForcedPaintingThresholdPriority

public void setForcedPaintingThresholdPriority(int aPriority)

Sets the threshold priority for forced label painting. The labels of objects with a priority value less than or equal to the threshold priority value will always be painted, even if the decluttering algorithm could not find any suitable place for the label. The default value is -1, in which case no forced painting is done.

Parameters:

aPriority - the threshold priority for forced label painting.

See Also:

getForcedPaintingThresholdPriority()

getForcedPaintingThresholdPriority

public int getForcedPaintingThresholdPriority()

Returns the threshold priority for forced label painting.

Returns:

the threshold priority for forced label painting.

See Also:

setForcedPaintingThresholdPriority(int)

invalidate

public void invalidate()

Invalidate any stored information about label locations in order to recalculate the label positions. To be used in cooperation with the property reusePreviousLocation if it is true.

clone

public Object clone()

Description copied from interface: ILcdGXYLayerLabelPainter

Redefines Object.clone to make it public.

Specified by:

clone in interface ILcdCloneable

Specified by:

clone in interface ILcdGXYLayerLabelPainter

Overrides:

clone in class Object

See Also:

Object.clone()