ilog.views.maps.label

Class IlvMapLineLabel

java.lang.Object

ilog.views.maps.label.IlvMapLabelingLabel

ilog.views.maps.label.IlvMapLineLabel

public class IlvMapLineLabel
extends IlvMapLabelingLabel

Class for displaying labels on polylines. The placeLabel() method will try several candidate positions on the visible part of the path (the way that candidates are generated depends on specified list of parameters). A candidate that does not intersect previously placed labels is then chosen.

Since:

JViews 7.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvMapLineLabel.ParameterRecord Advanced parameters for IlvMapLineLabel instances.

Constructor Summary

Constructors

Constructor and Description
IlvMapLineLabel(String label, IlvMapLabelStyle labelStyle, IlvMapPolyline poly, IlvMapLineLabel.ParameterRecord parameters) Public constructor.
IlvMapLineLabel(String label, Image image, IlvMapLabelStyle labelStyle, IlvPolyline poly, IlvMapLineLabel.ParameterRecord parameters) Public constructor.

Method Summary

Modifier and Type	Method and Description
static IlvMapLineLabel.ParameterRecord	getDefaultParameters(IlvMapLabelStyle style) Returns the advanced parameters to use for IlvMapLineLabel using the specified style.
void	placeLabels(IlvManagerView view, IlvLabelingAreas usedArea, boolean forceCompute) Method called when the position of this label 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

IlvMapLineLabel

public IlvMapLineLabel(String label,
                       Image image,
                       IlvMapLabelStyle labelStyle,
                       IlvPolyline poly,
                       IlvMapLineLabel.ParameterRecord parameters)

Public constructor.

Parameters:

label - Label text.

image - Label image.

labelStyle - Label style.

poly - IlvPolyline to which this label is attached.

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

See Also:

getDefaultParameters(IlvMapLabelStyle)

IlvMapLineLabel

public IlvMapLineLabel(String label,
                       IlvMapLabelStyle labelStyle,
                       IlvMapPolyline poly,
                       IlvMapLineLabel.ParameterRecord parameters)

Public constructor.

Parameters:

label - Label text.

labelStyle - Label style.

poly - IlvMapPolyline to which this label is attached.

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

See Also:

getDefaultParameters(IlvMapLabelStyle)

Method Detail

getDefaultParameters

public static IlvMapLineLabel.ParameterRecord getDefaultParameters(IlvMapLabelStyle style)

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

Parameters:

style - The style attached to the IlvMapLineLabel.

Returns:

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

Since:

JViews 8.5

See Also:

IlvMapLineLabel(String, IlvMapLabelStyle, IlvMapPolyline, ParameterRecord)

placeLabels

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

Method called when the position of this label 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 (otherwise just check that previously computed labels are still valid).