ilog.views.maps.labelling
Class IlvMapLabeler

java.lang.Object
  ilog.views.maps.labelling.IlvMapLabeler

Direct Known Subclasses:

IlvMapLabelerController

public class IlvMapLabeler
extends Object

The main labeling class. This class is a specific layout class that performs label layout on IlvAnchoredLabels. The layout itself is triggered by the call to the performLayout method. The layout is performed on the layers that have been registered in the labeler.

Since:

JViews 5.0

Constructor Summary

IlvMapLabeler()
Constructs the labeler.

Method Summary

void	addManagerLayer(IlvManagerLayer layer) Adds a layer to the list of layer to be taken in account.
IlvAnnealingLabelLayout	getLabelLayout() Retrieves the IlvAnnealingLabelLayout used to perform the layout.
IlvMapLayoutParameters	getLayoutParameters() Retrieves the parameters used by this labeler.
Enumeration	getManagerLayers() Retrieves the list of layers taken in account by the labeler.
boolean	isEnabled() Tells if the layout is enabled or not.
IlvLabelLayoutReport	performLayout(IlvManagerView view) Performs the label layout on the specified view.
void	removeManagerLayer(IlvManagerLayer layer) Remove a layer from the list of layer to be taken in account.
void	setEnabled(boolean enable) Enables or disables the layout.
void	setLayoutParameters(IlvMapLayoutParameters params) Sets the parameters to be used by this labeler.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapLabeler

public IlvMapLabeler()

Constructs the labeler.

Method Detail

getLabelLayout

public IlvAnnealingLabelLayout getLabelLayout()

Retrieves the IlvAnnealingLabelLayout used to perform the layout.

getLayoutParameters

public IlvMapLayoutParameters getLayoutParameters()

Retrieves the parameters used by this labeler.

setLayoutParameters

public void setLayoutParameters(IlvMapLayoutParameters params)

Sets the parameters to be used by this labeler.

addManagerLayer

public void addManagerLayer(IlvManagerLayer layer)

Adds a layer to the list of layer to be taken in account.

removeManagerLayer

public void removeManagerLayer(IlvManagerLayer layer)

Remove a layer from the list of layer to be taken in account.

getManagerLayers

public Enumeration getManagerLayers()

Retrieves the list of layers taken in account by the labeler.

performLayout

public IlvLabelLayoutReport performLayout(IlvManagerView view)

Performs the label layout on the specified view. The layout is only performed on objects visible in this view. An IlvLabelLayoutReport is returned or null if the layout is disabled.

setEnabled

public void setEnabled(boolean enable)

Enables or disables the layout. When the layout is disabled, the performLayout method returns immediately.

isEnabled

public boolean isEnabled()

Tells if the layout is enabled or not.