ilog.views.maps.label

Interface IlvMapLabeler

All Superinterfaces:

IlvPersistentObject, Serializable

All Known Implementing Classes:

IlvMapDefaultLabeler

public interface IlvMapLabeler
extends IlvPersistentObject

Interface defining the method that a IlvMapLabeler must implement. A labeler is responsible for labeling a map. Labels are usually drawn on the map retrieving values from IlvAttribute attached to graphic object. A default implementation of the IlvMapLabeler is IlvMapDefaultLabeler.

Since:

JViews 7.5

Method Summary

Modifier and Type	Method and Description
void	addLayer(IlvMapLayer layer) Add a layer to be labeled by this labeler.
IlvMapLabelingLabel[]	createLabels(IlvGraphic graphic, String message) Creates and sets up map label components.
IlvMapLayer	getLabeledLayer(IlvMapLayer labelLayer) Retrieves the IlvMapLayer for which this label layer has been created.
IlvMapLayer	getLabelLayer() Deprecated.
IlvMapLayer	getLabelLayer(IlvMapLayer layer) Retrieves the IlvMapLayer on which labels are drawn for this specific map layer.
Iterator<IlvMapLayer>	getLabelLayers() Returns The list of the label layers.
IlvMapLabelManager	getLabelManager() Retrieves the internal IlvMapLabelManager instance used to create labels.
IlvManagerView	getView() Retrieves the view associated to this labeler.
void	labelize() Deprecated. Use #performLabeling().
void	performLabeling() Performs the labeling.
void	removeLayer(IlvMapLayer layer) Removes a layer from this labeler.
void	setLabelLayer(IlvMapLayer layer) Sets the label layer.
void	setView(IlvManagerView view) Sets the view to the labeler.

Methods inherited from interface ilog.views.io.IlvPersistentObject

write

Method Detail

setView

void setView(IlvManagerView view)

Sets the view to the labeler.

Parameters:

view - The view to add.

getView

IlvManagerView getView()

Retrieves the view associated to this labeler.

Returns:

The view associated to this labeler.

addLayer

void addLayer(IlvMapLayer layer)

Add a layer to be labeled by this labeler.

Parameters:

layer - A new layer to be labeled.

removeLayer

void removeLayer(IlvMapLayer layer)

Removes a layer from this labeler. The specified layer will no longer be labeled by this labeler.

Parameters:

layer - The layer to remove.

getLabelLayer

IlvMapLayer getLabelLayer(IlvMapLayer layer)

Retrieves the IlvMapLayer on which labels are drawn for this specific map layer.

Parameters:

layer - the layer to retrieve label layer for.

Returns:

The label IlvMapLayer

Since:

JViews 7.5

getLabeledLayer

IlvMapLayer getLabeledLayer(IlvMapLayer labelLayer)

Retrieves the IlvMapLayer for which this label layer has been created.

Parameters:

labelLayer - The label layer for which you want to retrieve the source layer.

Returns:

The source IlvMapLayer.

Since:

JViews 8.8

getLabelManager

IlvMapLabelManager getLabelManager()

Retrieves the internal IlvMapLabelManager instance used to create labels.

Returns:

The source IlvMapLayer.

Since:

JViews 8.8

getLabelLayer

@Deprecated
IlvMapLayer getLabelLayer()

Deprecated.

Retrieves the IlvMapLayer on which labels are drawn. use getLabelLayer(IlvMapLayer) instead.

Returns:

The label IlvMapLayer

createLabels

IlvMapLabelingLabel[] createLabels(IlvGraphic graphic,
                                   String message)

Creates and sets up map label components. Composite objects such as IlvGraphicSet can have more than one label component. This utility method is typically used in IlvMapLabelFactory.getGisLabel(IlvGraphic).

Parameters:

graphic - The graphic object for which one or more labels should be created.

message - A String containing the label message.

Returns:

The table of label components created for this graphic object.

Since:

JViews 8.8

setLabelLayer

void setLabelLayer(IlvMapLayer layer)

Sets the label layer.

Parameters:

layer - The new label layer.

labelize

@Deprecated
void labelize()

Deprecated. Use #performLabeling().

Performs the labeling.

performLabeling

void performLabeling()

Performs the labeling.

Since:

JViews 8.0

getLabelLayers

Iterator<IlvMapLayer> getLabelLayers()

Returns The list of the label layers.

Returns:

The list of the label layers.

Since:

JViews 8.0