Package com.luciad.view.gxy.labeling

Class TLcdGXYLabelPlacer

java.lang.Object

com.luciad.view.gxy.labeling.TLcdGXYLabelPlacer

All Implemented Interfaces:

ILcdCloneable, ILcdGXYViewLabelPlacer, Cloneable

public class TLcdGXYLabelPlacer
extends Object
implements ILcdGXYViewLabelPlacer

This ILcdGXYViewLabelPlacer places the labels using a given algorithm. This label placer executes the label placing and the labeling algorithm on the EventDispatch thread.

Note: When using this label placer in combination with asynchronous painting, it passes the wrapped layer to the labeling algorithm, and not the asynchronous layer wrapper.

Since:

10.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.luciad.view.gxy.labeling.ILcdGXYViewLabelPlacer

ILcdGXYViewLabelPlacer.ViewLabelPlacerCallback

Constructor Summary

Constructors

Constructor	Description
TLcdGXYLabelPlacer()	Create a new label placer with a labeling algorithm that delegates to the appropriate layer's labeling algorithm.
TLcdGXYLabelPlacer(ILcdGXYLabelingAlgorithm aLabelingAlgorithm)	Create a new label placer based on the given algorithm.

Method Summary

Modifier and Type	Method	Description
void	addStatusListener(ILcdStatusListener aListener)	Adds the given status listener to this view label placer.
TLcdGXYLabelPlacer	clone()	Makes Object.clone() public.
ILcdLabelConflictChecker	getLabelConflictChecker()	Returns the label conflict checker used when placing labels.
ILcdGXYLabelingAlgorithm	getLabelingAlgorithm()	Returns the used labeling algorithm.
ILcdGXYLabelObstacleProvider	getLabelObstacleProvider()	Returns the used ILcdGXYLabelObstacleProvider.
void	placeLabels(Graphics aGraphics, ILcdGXYView aGXYView, ILcdGXYViewLabelPlacer.ViewLabelPlacerCallback aCallback)	The implementation of this method shall define how to place the labels of all objects in the various ILcdGXYLayers of the given ILcdGXYView.
void	placeLabels(Graphics aGraphics, List<ILcdGXYLayer> aGXYLayers, ILcdGXYView aGXYView, ILcdGXYViewLabelPlacer.ViewLabelPlacerCallback aCallback)	The implementation of this method shall define how to place the labels of all objects in the various ILcdGXYLayers from the given List.
void	removeStatusListener(ILcdStatusListener aListener)	Removes the given status listener from this view label placer.
void	setAlgorithm(ILcdGXYLabelingAlgorithm aLabelingAlgorithm)	Sets the given labeling algorithm.
void	setLabelConflictChecker(ILcdLabelConflictChecker aLabelConflictChecker)	Sets the label conflict checker to be used when placing labels.
void	setLabelObstacleProvider(ILcdGXYLabelObstacleProvider aLabelObstacleProvider)	Sets the used label obstacle provider.

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdGXYLabelPlacer

public TLcdGXYLabelPlacer()

Create a new label placer with a labeling algorithm that delegates to the appropriate layer's labeling algorithm.

TLcdGXYLabelPlacer

public TLcdGXYLabelPlacer(ILcdGXYLabelingAlgorithm aLabelingAlgorithm)

Create a new label placer based on the given algorithm.

Warning: when calling this constructor you are overriding the the layer's own label algorithms.

Parameters:

aLabelingAlgorithm - a labeling algorithm.

Method Details

getLabelingAlgorithm

public ILcdGXYLabelingAlgorithm getLabelingAlgorithm()

Returns the used labeling algorithm.

Returns:

the used labeling algorithm.

setAlgorithm

public void setAlgorithm(ILcdGXYLabelingAlgorithm aLabelingAlgorithm)

Sets the given labeling algorithm.

Warning: using this constructor you are overriding the the layer's own label algorithms.

Parameters:

aLabelingAlgorithm - a labeling algorithm.

getLabelConflictChecker

public ILcdLabelConflictChecker getLabelConflictChecker()

Returns the label conflict checker used when placing labels.

Returns:

aLabelConflictChecker the label conflict checker used when placing labels.

See Also:

• setLabelConflictChecker(com.luciad.view.labeling.algorithm.ILcdLabelConflictChecker)

setLabelConflictChecker

public void setLabelConflictChecker(ILcdLabelConflictChecker aLabelConflictChecker)

Sets the label conflict checker to be used when placing labels.

Parameters:

aLabelConflictChecker - the label conflict checker to be used when placing labels.

See Also:

• getLabelConflictChecker()

getLabelObstacleProvider

public ILcdGXYLabelObstacleProvider getLabelObstacleProvider()

Returns the used ILcdGXYLabelObstacleProvider.

Returns:

the used ILcdGXYLabelObstacleProvider, or null if no label obstacle provider is used.

See Also:

• setLabelObstacleProvider(com.luciad.view.gxy.ILcdGXYLabelObstacleProvider)

setLabelObstacleProvider

public void setLabelObstacleProvider(ILcdGXYLabelObstacleProvider aLabelObstacleProvider)

Sets the used label obstacle provider. This obstacle provider is used to provide the labeling algorithm with obstacles: places where preferably no labels are placed.

The default value is null.

Parameters:

aLabelObstacleProvider - a label obstacle provider.

See Also:

• getLabelObstacleProvider()

clone

public TLcdGXYLabelPlacer clone()

Description copied from interface: ILcdCloneable

Makes Object.clone() public.

When for example extending from java.lang.Object, it can be implemented like this:

 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class Object

See Also:

• Object.clone()

placeLabels

public void placeLabels(Graphics aGraphics,
 ILcdGXYView aGXYView,
 ILcdGXYViewLabelPlacer.ViewLabelPlacerCallback aCallback)

Description copied from interface: ILcdGXYViewLabelPlacer

The implementation of this method shall define how to place the labels of all objects in the various ILcdGXYLayers of the given ILcdGXYView. Here one can implement or use various smart algorithms to check whether or not to place a label at a certain location.

Layers for which labels are placed should be ILcdGXYEditableLabelsLayers. This method should then inform the ALcdLabelLocations associated with that layer which labels were placed, and where they were placed.

This method should only be called once every time the view is invalidated.

Specified by:

placeLabels in interface ILcdGXYViewLabelPlacer

Parameters:

aGraphics - The current Graphics instance.

aGXYView - The view for which to place the labels.

aCallback - Will be invoked when labels are updated, and when the label placing has ended.

See Also:

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

placeLabels

public void placeLabels(Graphics aGraphics,
 List<ILcdGXYLayer> aGXYLayers,
 ILcdGXYView aGXYView,
 ILcdGXYViewLabelPlacer.ViewLabelPlacerCallback aCallback)

Description copied from interface: ILcdGXYViewLabelPlacer

The implementation of this method shall define how to place the labels of all objects in the various ILcdGXYLayers from the given List. Here one can implement or use various smart algorithms to check whether or not to place a label at a certain location.

Layers for which labels are placed should be ILcdGXYEditableLabelsLayers. This method should then inform the ALcdLabelLocations associated with that layer which labels were placed, and where they were placed.

This method should only be called once every time the view is invalidated.

Specified by:

placeLabels in interface ILcdGXYViewLabelPlacer

Parameters:

aGraphics - The current Graphics instance.

aGXYLayers - Only the labels for the layers in this List will be placed.

aGXYView - The view for which to place the labels.

aCallback - Will be invoked when labels are updated, and when the label placing has ended.

See Also:

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

addStatusListener

public void addStatusListener(ILcdStatusListener aListener)

Description copied from interface: ILcdGXYViewLabelPlacer

Adds the given status listener to this view label placer. Whenever an event occurs concerning the labeling process, this listener is notified.

Specified by:

addStatusListener in interface ILcdGXYViewLabelPlacer

Parameters:

aListener - a labeling listener.

removeStatusListener

public void removeStatusListener(ILcdStatusListener aListener)

Description copied from interface: ILcdGXYViewLabelPlacer

Removes the given status listener from this view label placer. After calling this method, the given listener will not be notified anymore.

Specified by:

removeStatusListener in interface ILcdGXYViewLabelPlacer

Parameters:

aListener - a labeling listener.