com.luciad.view.gxy

LuciadLightspeedClass TLcdGXYCurvedPathLabelPainter

java.lang.Object

com.luciad.view.gxy.ALcdGXYLabelPainter

com.luciad.view.gxy.TLcdGXYCurvedPathLabelPainter

All Implemented Interfaces:

ILcdPropertyChangeSource, ILcdGXYLabelPainter, ILcdGXYLabelPainter2, ILcdGXYLabelPainterProvider, ILcdGXYMultiLabelPainter, Serializable, Cloneable

public class TLcdGXYCurvedPathLabelPainter
extends ALcdGXYLabelPainter
implements ILcdGXYLabelPainterProvider

This label painter paints curved text strings along a path. To do this it uses a path provider to calculate the path on which to place the text.

This label painter can paint curved labels if a TLcdGXYCurvedPathLabelLocation is used. Usually this is done by changing the layer's label locations. For a TLcdGXYLayer, this could be done as follows:

 layer.setLabelLocations( new TLcdLabelLocations( layer, new TLcdGXYCurvedPathLabelLocation() ) );
 

The curved label location class describes an exact location on an ILcdAWTPath. It defines the following 3 fields:

• TLcdGXYCurvedPathLabelLocation.getLocationIndex()</code> : should be <code>-1.
• TLcdGXYCurvedPathLabelLocation.getSubPathIndex()
• TLcdGXYCurvedPathLabelLocation.getAWTPathParameter()

The rest of the fields are ignored since the position and rotation of the text are calculated using these 3 fields.

TLcdGXYCurvedPathLabelingAlgorithm can be used to place curved path labels. This labeling algorithm also works using TLcdGXYCurvedPathLabelLocations, and fills in the 'sub path index' and 'awt path parameter' fields.

This label painter also supports fixed label placement (TLcdLabelLocation.getLocationIndex() >= 0)). In that case it drapes the label at the middle of the path (sub path index = 0 and awt path parameter = 0.5). This allows this label painter to be used in combination with TLcdGXYLabelPainterLocationLabelingAlgorithm.

It also supports regular free placement, in case an invalid awt path parameter is used. I.e. if the path parameter < 0 or > 1 and if TLcdLabelLocation.getLocationIndex() == -1. In that case, the label is placed as described by

• TLcdLabelLocation.getRotation()
• TLcdLabelLocation.getLocationX()
• TLcdLabelLocation.getLocationY()

The label will not be curved in this case. This allows this label painter to be used in combination with all labeling algorithms that output a free placement label location.

Note: Wrapping or extending this label painter will not always work as expected. For example, when the labelBoundsSFCT method is customized using a wrapper or an extension of this label painter, the labeling algorithm will not be able to use this information. So it will work with other bounds than the one returned by the used label painter. This might cause overlapping labels.

Since:

11.0

See Also:

TLcdGXYCurvedPathLabelLocation, TLcdGXYCurvedPathLabelingAlgorithm, ILcdGXYEditableLabelsLayer, Serialized Form

Field Summary

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

BODY, CREATING, HANDLES, RESHAPING, SNAPS, TRANSLATING

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

DEFAULT, SELECTED

Constructor Summary

Constructors

Constructor and Description
TLcdGXYCurvedPathLabelPainter() Creates a new TLcdGXYCurvedPathLabelPainter, using TLcdGXYLabelingPathProvider as path provider.
TLcdGXYCurvedPathLabelPainter(ILcdGXYLabelingPathProvider aPathProvider) Creates a new TLcdGXYCurvedPathLabelPainter, using the given path provider.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener) Adds a PropertyChangeListener to this painter.
void	clearImageCache() Clears the entire label image cache.
void	clearImageCache(Object aObject) Clears the label image cache for the given object.
Object	clone() Returns a new instance of this ALcdGXYLabelPainter.
double	getExtraCharacterSpacing() Returns the extra spacing between each character.
Font	getFont() Gets the Font for drawing the labels.
Color	getForeground() Gets the foreground color of the labels (text).
ILcdGXYLabelPainter	getGXYLabelPainter(Object aObject) Finds an ILcdGXYLabelPainter that can be used to label the object passed.
TLcdHaloAlgorithm	getHaloAlgorithm() Returns the algorithm that is used for rendering halo's.
Color	getHaloColor() Returns the current halo color.
int	getHaloThickness() Returns the current halo thickness.
ILcdGXYLabelingPathProvider	getPathProvider() Returns the used path provider.
int	getPossibleLocationCount(Graphics aGraphics) Returns the number of possible locations where this ILcdGXYLabelPainter can paint/draw the labels of the set domain Object.
Color	getSelectionColor() Gets the selection color of a label
boolean	isHaloEnabled() Returns true if the halo effect is on for the labels, false otherwise.
boolean	isLabelTouched(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Tests if the label specified by setObject, setLabelIndex and setSubLabelIndex is touched at view location (specified by aGXYContext.getX() and aGXYContext.getY()), considering the mode and the ILcdGXYContext instance.
boolean	isUseImageCache() Returns true</code> when label image caching is enabled, <code>false otherwise.
void	labelAnchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aPointSFCT) Sets aPointSFCT to the anchor point of the label specified by setObject, setLabelIndex and setSubLabelIndex.
double	labelBoundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Rectangle aRectangleSFCT) Calculates the bounds of the label that can be painted.
void	paintLabel(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Paints the label specified by setObject, setLabelIndex and setSubLabelIndex on aGraphics.
void	removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener) Removes a PropertyChangeListener from this painter.
String	retrieveLabels(Object aObject, int aLabelIndex, int aSubLabelIndex) This method should return the label text.
void	setExtraCharacterSpacing(double aExtraCharacterSpacing) Sets an extra spacing between each two characters in the label String.
void	setFont(Font aFont) Sets the Font</code> for drawing the labels to <code>aFont.
void	setForeground(Color aForegroundColor) Sets the color of the labels to aForegroundColor.
void	setHaloAlgorithm(TLcdHaloAlgorithm aHaloAlgorithm) Sets the algorithm to be used for rendering halo's.
void	setHaloColor(Color aColor) Sets the color of the halo to be added around labels.
void	setHaloEnabled(boolean aHaloEnabled) Switches the halo effect for the labels on or off.
void	setHaloThickness(int aThickness) Sets the thickness (in pixels) of the halo to be added around labels.
void	setSelectionColor(Color aSelectionColor) Sets the selection color of a label to aSelectionColor.
void	setUseImageCache(boolean aUseCache) Sets whether or not labels with halos should be cached as images.

Methods inherited from class com.luciad.view.gxy.ALcdGXYLabelPainter

firePropertyChangeEvent, getDisplayName, getLabelCount, getLabelCursor, getLabelIndex, getLabelLocation, getLocationIndex, getObject, getSubLabelCount, getSubLabelIndex, labelSnapTarget, setDisplayName, setLabelIndex, setLabelLocation, setLocationIndex, setObject, setSubLabelIndex, supportLabelSnap

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdGXYCurvedPathLabelPainter

public TLcdGXYCurvedPathLabelPainter()

Creates a new TLcdGXYCurvedPathLabelPainter, using TLcdGXYLabelingPathProvider as path provider.

TLcdGXYCurvedPathLabelPainter

public TLcdGXYCurvedPathLabelPainter(ILcdGXYLabelingPathProvider aPathProvider)

Creates a new TLcdGXYCurvedPathLabelPainter, using the given path provider.

Parameters:

aPathProvider - a path provider.

Method Detail

getPathProvider

public ILcdGXYLabelingPathProvider getPathProvider()

Returns the used path provider.

Returns:

the used path provider.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Adds a PropertyChangeListener to this painter.

Specified by:

addPropertyChangeListener in interface ILcdPropertyChangeSource

Overrides:

addPropertyChangeListener in class ALcdGXYLabelPainter

Parameters:

aPropertyChangeListener - the receiver of property change events generated by this object

See Also:

removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Removes a PropertyChangeListener from this painter.

Specified by:

removePropertyChangeListener in interface ILcdPropertyChangeSource

Overrides:

removePropertyChangeListener in class ALcdGXYLabelPainter

Parameters:

aPropertyChangeListener - the listener to be removed

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener)

isHaloEnabled

public boolean isHaloEnabled()

Returns true if the halo effect is on for the labels, false otherwise.

Returns:

true if the halo effect is on, false otherwise

See Also:

setHaloEnabled(boolean)

setHaloEnabled

public void setHaloEnabled(boolean aHaloEnabled)

Switches the halo effect for the labels on or off.

Parameters:

aHaloEnabled - true if halos should be added, false otherwise

See Also:

isHaloEnabled()

getHaloThickness

public int getHaloThickness()

Returns the current halo thickness.

Returns:

the current halo thickness

See Also:

setHaloThickness(int)

setHaloThickness

public void setHaloThickness(int aThickness)

Sets the thickness (in pixels) of the halo to be added around labels.

Parameters:

aThickness - the new halo thickness

See Also:

TLcdGXYHaloLabelPainter.setHaloThickness(int), setHaloEnabled(boolean)

getHaloColor

public Color getHaloColor()

Returns the current halo color.

Returns:

the current halo color

See Also:

setHaloColor(java.awt.Color)

setHaloColor

public void setHaloColor(Color aColor)

Sets the color of the halo to be added around labels.

Parameters:

aColor - the new halo color

See Also:

TLcdGXYHaloLabelPainter.setHaloColor(java.awt.Color), setHaloEnabled(boolean)

setHaloAlgorithm

public void setHaloAlgorithm(TLcdHaloAlgorithm aHaloAlgorithm)

Sets the algorithm to be used for rendering halo's. The choice of the halo algorithm may have a major impact on the overall performance of this painter. See TLcdHaloAlgorithm for more information on the available algorithms.

Parameters:

aHaloAlgorithm - the algorithm to be used for rendering halo's.

See Also:

TLcdHaloAlgorithm, getHaloAlgorithm(), setHaloEnabled(boolean)

getHaloAlgorithm

public TLcdHaloAlgorithm getHaloAlgorithm()

Returns the algorithm that is used for rendering halo's.

Returns:

the algorithm that is used for rendering halo's.

See Also:

TLcdHaloAlgorithm, setHaloAlgorithm(com.luciad.util.TLcdHaloAlgorithm)

isUseImageCache

public boolean isUseImageCache()

Returns true</code> when label image caching is enabled, <code>false otherwise.

Returns:

true</code> when label image caching is enabled, <code>false otherwise

See Also:

setUseImageCache(boolean)

setUseImageCache

public void setUseImageCache(boolean aUseCache)

Sets whether or not labels with halos should be cached as images.

Parameters:

aUseCache - specifies whether image caching should be enabled

See Also:

TLcdGXYHaloLabelPainter.setUseImageCache(boolean), setHaloEnabled(boolean), isUseImageCache()

clearImageCache

public void clearImageCache()

Clears the entire label image cache. To remove the label cache from a single object, use clearImageCache(Object).

See Also:

setUseImageCache(boolean)

clearImageCache

public void clearImageCache(Object aObject)

Clears the label image cache for the given object. The next time this object is painted, a new image will be created and cached for it. To remove all cached images in one go, use clearImageCache().

Parameters:

aObject - the object for which the cache to be cleared.

See Also:

setUseImageCache(boolean)

setFont

public void setFont(Font aFont)

Sets the Font</code> for drawing the labels to <code>aFont.

Parameters:

aFont - the font to use to paint labels.

See Also:

getFont()

getFont

public Font getFont()

Gets the Font for drawing the labels. The default value is plain Dialog of size 10.

Returns:

the font used to paint labels.

See Also:

setFont(java.awt.Font)

setForeground

public void setForeground(Color aForegroundColor)

Sets the color of the labels to aForegroundColor.

Parameters:

aForegroundColor - the color to be used to paint the labels foreground (text).

See Also:

getForeground()

getForeground

public Color getForeground()

Gets the foreground color of the labels (text).

Returns:

the foreground color of the labels (text).

See Also:

setForeground(java.awt.Color)

setSelectionColor

public void setSelectionColor(Color aSelectionColor)

Sets the selection color of a label to aSelectionColor.

Parameters:

aSelectionColor - the color to use to paint labels for selected objects.

See Also:

getSelectionColor()

getSelectionColor

public Color getSelectionColor()

Gets the selection color of a label

Returns:

the selection color of a label.

See Also:

setSelectionColor(java.awt.Color)

getExtraCharacterSpacing

public double getExtraCharacterSpacing()

Returns the extra spacing between each character.

Returns:

the extra spacing between each character.

See Also:

setExtraCharacterSpacing(double)

setExtraCharacterSpacing

public void setExtraCharacterSpacing(double aExtraCharacterSpacing)

Sets an extra spacing between each two characters in the label String. The extra spacing is expressed in view coordinates (pixels). This value is 0.0 by default.

Parameters:

aExtraCharacterSpacing - the extra spacing between two characters in the label String.

See Also:

getExtraCharacterSpacing()

retrieveLabels

public String retrieveLabels(Object aObject,
                             int aLabelIndex,
                             int aSubLabelIndex)

This method should return the label text. Override this method to return a custom string for a label.

Parameters:

aObject - the labeled object.

aLabelIndex - the label index.

aSubLabelIndex - the sublabel index.

Returns:

a String for the given label.

paintLabel

public void paintLabel(Graphics aGraphics,
                       int aMode,
                       ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYLabelPainter2

Paints the label specified by setObject, setLabelIndex and setSubLabelIndex on aGraphics. aGXYContext should contain the ILcdGXYView for which the label is painted and ILcdGXYLayer to which the object belongs

The implementation of this method shall define how to paint the specified label in the given mode, considering aGXYContext and the set TLcdLabelLocation.

The domain object, label index, sublabel index and the label location should be set before calling this method using the respective methods.

This interface extends the original contract of the paintLabel method to allow for more modes. Where in the super interface the mode could only be one of ILcdGXYLabelPainter.DEFAULT or ILcdGXYLabelPainter.SELECTED, the mode now can be a bitwise combination of several constants

Specified by:

paintLabel in interface ILcdGXYLabelPainter

Specified by:

paintLabel in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - The graphics object to paint the label on

aMode - A bitwise combination of

• either ILcdGXYLabelPainter.DEFAULT or ILcdGXYLabelPainter.SELECTED
• either ILcdGXYLabelPainter2.BODY, ILcdGXYLabelPainter2.HANDLES or ILcdGXYLabelPainter2.SNAPS
• either ILcdGXYLabelPainter2.TRANSLATING, ILcdGXYLabelPainter2.RESHAPING, ILcdGXYLabelPainter2.CREATING or nothing

aGXYContext - the drawing context for the label

See Also:

ILcdGXYLabelPainter.DEFAULT, ILcdGXYLabelPainter.SELECTED

labelBoundsSFCT

public double labelBoundsSFCT(Graphics aGraphics,
                              int aMode,
                              ILcdGXYContext aGXYContext,
                              Rectangle aRectangleSFCT)
                       throws TLcdNoBoundsException

Description copied from interface: ILcdGXYLabelPainter2

Calculates the bounds of the label that can be painted. The bounds are set as a side effect in aRectangleSFCT, the orientation of aRectangleSFCT is returned as an angle.

The bounds represent the upper left point of the label, and a width and a height. The rotation value represents the rotation of the label bounds around the upper left point.

The domain object, the label index, the sublabel index and the location of the label for which the bounds are retrieved should be set before calling this method using the respective methods.

Note that if this label painter is used in conjunction with a labeling algorithm, the bounds should preferably be independent of the location, as this will yield the best results.

Specified by:

labelBoundsSFCT in interface ILcdGXYLabelPainter

Specified by:

labelBoundsSFCT in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - the aGraphics to consider.

aMode - the representation mode of the label.

aGXYContext - the ILcdGXYContext the drawing depends on.

aRectangleSFCT - the Rectangle containing the bounds of the label in view / graphics coordinates as side effect.

Returns:

the angle orientation of the rectangle around the labels in RADIANs, clockwise, 0 at 3 o'clock.

Throws:

TLcdNoBoundsException - if the Object doesn't have any valid bounds, e.g. if it is always invisible in the current projection.

See Also:

ILcdGXYViewLabelPainter, ILcdGXYLayerLabelPainter, ILcdGXYLabelPainter2.labelAnchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point)

isLabelTouched

public boolean isLabelTouched(Graphics aGraphics,
                              int aMode,
                              ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYLabelPainter2

Tests if the label specified by setObject, setLabelIndex and setSubLabelIndex is touched at view location (specified by aGXYContext.getX() and aGXYContext.getY()), considering the mode and the ILcdGXYContext instance.

Before calling this method, the domain object, the label index, the sublabel index and the location of the label should be set using the respective methods.

Specified by:

isLabelTouched in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - The Graphics instance on which the label is painted.

aMode - the mode to consider. This is a bitwise combinations of several constants. See ILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) for more information.

aGXYContext - the ILcdGXYContext to consider.

Returns:

true if the representation of the Object returned by getObject() is touched, false otherwise

See Also:

ILcdGXYContext

labelAnchorPointSFCT

public void labelAnchorPointSFCT(Graphics aGraphics,
                                 int aMode,
                                 ILcdGXYContext aGXYContext,
                                 Point aPointSFCT)
                          throws TLcdNoBoundsException

Description copied from interface: ILcdGXYLabelPainter2

Sets aPointSFCT to the anchor point of the label specified by setObject, setLabelIndex and setSubLabelIndex.

If the location index is less than 0, the label anchor point is unambiguously determined by the label location. The actual label is to be painted somewhere around this anchor point. This method is typically called to compare the result with the label bounds, thus determining the exact relation between the label and its location.

Before calling this method, the domain object, the label index, the sublabel index and the location of the label should be set using the respective methods.

Specified by:

labelAnchorPointSFCT in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - The Graphics instance on which the label is painted.

aMode - The mode to consider. This can be a bitwise combination of several constants. See ILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) for more information.

aGXYContext - The ILcdGXYContext that can be used to retrieve extra information.

aPointSFCT - The point which will be updated to reflect the location of the anchor point.

Throws:

TLcdNoBoundsException - if the Object doesn't have any valid anchor point, e.g. if it is always invisible in the current projection.

See Also:

ILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYLabelPainter2.getLabelLocation(), ILcdGXYLabelPainter2.labelBoundsSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Rectangle)

getPossibleLocationCount

public int getPossibleLocationCount(Graphics aGraphics)

Description copied from interface: ILcdGXYLabelPainter

Returns the number of possible locations where this ILcdGXYLabelPainter can paint/draw the labels of the set domain Object.

The domain Object for which the location count is retrieved should be set before calling this method using the ILcdGXYLabelPainter.setObject(java.lang.Object) method.

Specified by:

getPossibleLocationCount in interface ILcdGXYLabelPainter

Parameters:

aGraphics - the Graphics the label will be painted on.

Returns:

the number of possible locations where this ILcdGXYLabelPainter can paint/draw the labels of the set Object.

See Also:

ILcdGXYLabelPainter.setLocationIndex(int)

getGXYLabelPainter

public ILcdGXYLabelPainter getGXYLabelPainter(Object aObject)

Description copied from interface: ILcdGXYLabelPainterProvider

Finds an ILcdGXYLabelPainter that can be used to label the object passed.

The label painter provider is responsible for setting the object to the label painter before returning the label painter. An implementation should therefore have the following structure:

 public ILcdGXYLabelPainter getGXYLabelPainter(Object aObject) {
   ILcdGXYLabelPainter labelPainter = ... // find the label painter for the object
   if (labelPainter != null) {
    labelPainter.setObject(aObject);
   }
   return labelPainter;
 }
 

Specified by:

getGXYLabelPainter in interface ILcdGXYLabelPainterProvider

Parameters:

aObject - the object to find a label painter for

Returns:

a label painter that can be used to label the object; or null if no label painter could be found for the given object, or the object could not be set on the retrieved label painter.

clone

public Object clone()

Description copied from class: ALcdGXYLabelPainter

Returns a new instance of this ALcdGXYLabelPainter. The label location of the clone is a clone of the label location of the original. No other objects are cloned.

Specified by:

clone in interface ILcdGXYLabelPainter

Specified by:

clone in interface ILcdGXYLabelPainter2

Specified by:

clone in interface ILcdGXYLabelPainterProvider

Overrides:

clone in class ALcdGXYLabelPainter

Returns:

A new instance of this ALcdGXYLabelPainter of which the label location is a deep clone.