ilog.views.maps.label

Class IlvMapAreaLabel

java.lang.Object

ilog.views.maps.label.IlvMapLabelingLabel

ilog.views.maps.label.IlvMapAreaLabel

public class IlvMapAreaLabel
extends IlvMapLabelingLabel

Class for displaying labels on areas (that is, closed polylines). The placeLabel() method will try several candidate positions inside the visible part (on the view passed in the parameter). The first candidate that does not intersect previously placed labels is chosen.

Since:

JViews 7.5

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static IlvMapAreaLabel.ParameterRecord	getDefaultParameters(IlvMapLabelStyle style) Returns the advanced parameters to use for IlvMapAreaLabel 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

IlvMapAreaLabel

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

Public constructor.

Parameters:

label - Label text.

image - Label icon.

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)

IlvMapAreaLabel

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

Public constructor.

Parameters:

label - The label text.

labelStyle - The label style.

poly - IlvMapPolyline to which this label is attached.

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

See Also:

getDefaultParameters(IlvMapLabelStyle)

Method Detail

getDefaultParameters

public static IlvMapAreaLabel.ParameterRecord getDefaultParameters(IlvMapLabelStyle style)

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

Parameters:

style - The style attached to the IlvMapAreaLabel.

Returns:

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

Since:

JViews 8.5

See Also:

IlvMapAreaLabel(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.