ilog.views.maps.label

Class IlvMapPointLabel

java.lang.Object

ilog.views.maps.label.IlvMapLabelingLabel

ilog.views.maps.label.IlvMapPointLabel

public class IlvMapPointLabel
extends IlvMapLabelingLabel

Class for displaying labels on IlvMapPoints. For each IlvMapPoint passed as parameter, the placeLabels() method will try 4 candidate positions about the point (ordered according to general label quality criteria, North-East, South-East, North-West, South-West). The first candidate that does not intersect previously placed labels is chosen. Otherwise this label is not drawn.

Since:

JViews 7.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvMapPointLabel.ParameterRecord Class holding parameters for IlvMapPointLabel instances

Constructor Summary

Constructors

Constructor and Description
IlvMapPointLabel(String label, IlvMapLabelStyle labelStyle, IlvPoint[] points, IlvMapPointLabel.ParameterRecord parameters) Public constructor.
IlvMapPointLabel(String label, Image image, IlvMapLabelStyle labelStyle, IlvPoint[] points, IlvMapPointLabel.ParameterRecord parameters) Public constructor.

Method Summary

Modifier and Type	Method and Description
static IlvMapPointLabel.ParameterRecord	getDefaultParameters(IlvMapLabelStyle style) Returns the advanced parameters to use for IlvMapPointLabel using the specified style.
void	placeLabels(IlvManagerView view, IlvLabelingAreas usedArea, boolean forceCompute) Method called when this label's position on screen needs to be computed.

Methods inherited from class ilog.views.maps.label.IlvMapLabelingLabel

drawLabel, getImage, getImageAnchorPoints, getLabelShapes, getLabelStyle, getOutlineShapes, getText, isTextRTL, setImage, setLabelStyle, setText

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapPointLabel

public IlvMapPointLabel(String label,
                        Image image,
                        IlvMapLabelStyle labelStyle,
                        IlvPoint[] points,
                        IlvMapPointLabel.ParameterRecord parameters)

Public constructor.

Parameters:

label - Label text.

image - Label icon.

labelStyle - Label style.

points - Array of points to label.

parameters - Placement parameters for this label. If parameters is null, default parameters will be used.

See Also:

getDefaultParameters(IlvMapLabelStyle)

IlvMapPointLabel

public IlvMapPointLabel(String label,
                        IlvMapLabelStyle labelStyle,
                        IlvPoint[] points,
                        IlvMapPointLabel.ParameterRecord parameters)

Public constructor.

Parameters:

label - Label text.

labelStyle - Label style.

points - Array of points to label.

parameters - Placement parameters for this label. If parameters is null, default parameters will be used.

See Also:

getDefaultParameters(IlvMapLabelStyle)

Method Detail

placeLabels

public void placeLabels(IlvManagerView view,
                        IlvLabelingAreas usedArea,
                        boolean forceCompute)

Method called when this label's position on screen needs to be computed.

Specified by:

placeLabels in class IlvMapLabelingLabel

Parameters:

view - The IlvManagerView the label is going to be drawn into.

usedArea - A forbidden area that the label must not intersect (previously placed labels).

forceCompute - Forces a new computation.

getDefaultParameters

public static IlvMapPointLabel.ParameterRecord getDefaultParameters(IlvMapLabelStyle style)

Returns the advanced parameters to use for IlvMapPointLabel using the specified style.

Parameters:

style - The style attached to the IlvMapPointLabel.

Returns:

The placement parameters used when an IlvMapPointLabel is created with this style.

Since:

JViews 8.5

See Also:

IlvMapPointLabel(String, IlvMapLabelStyle, IlvPoint[], ParameterRecord)