ilog.views.graphlayout.labellayout.annealing

Interface IlvAnnealingLabelDescriptorProvider

public interface IlvAnnealingLabelDescriptorProvider

This interface is useful if your application knows which labels belong to which related obstacle even when there are no label descriptors. For such an application, you can generate the label descriptors on the fly and hence do not need to worry anymore about setting label descriptors in advance. You simply implement this interface, specify the provider via IlvAnnealingLabelLayout.setLabelDescriptorProvider(IlvAnnealingLabelDescriptorProvider) and then don't need to call IlvAnnealingLabelLayout.setLabelDescriptor(Object, IlvAnnealingLabelDescriptor), since the provider mechanism does it for you.

Since:

JViews 8.5

Method Summary

Modifier and Type	Method and Description
IlvAnnealingLabelDescriptor	getLabelDescriptor(IlvAnnealingLabelLayout layout, Object label) Returns the label descriptor of a label.
Enumeration	getLabels(IlvAnnealingLabelLayout layout, Object obstacle) Returns all labels associated with a specific obstacle.

Method Detail

getLabelDescriptor

IlvAnnealingLabelDescriptor getLabelDescriptor(IlvAnnealingLabelLayout layout,
                                               Object label)

Returns the label descriptor of a label. When the provider is installed at the annealing label layout, the layout calls the provider for each label that has no label descriptor yet. A provider implementing this interface can then allocate an appropriate label descriptor on the fly. If null is returned, the label layout will only take the label descriptors into account, that where explicitly set for this label via IlvAnnealingLabelLayout.setLabelDescriptor(Object, IlvAnnealingLabelDescriptor).

Parameters:

layout - The layout instance.

label - The label whose descriptor is requested.

Returns:

The label descriptor of the given label.

getLabels

Enumeration getLabels(IlvAnnealingLabelLayout layout,
                      Object obstacle)

Returns all labels associated with a specific obstacle. The label descriptors of these labels should have this obstacle as related obstacle. The purpose of this method is to quickly retrieve all labels of a new obstacle in order to create label descritors for these labels. These labels must be part of the labeling model attached to the input layout. If null is returned, the label layout will only know about the labels of an object after the label descriptor was set via IlvAnnealingLabelLayout.setLabelDescriptor(Object, IlvAnnealingLabelDescriptor).

Parameters:

layout - The layout instance.

obstacle - The obstacle whose labels are requested.

Returns:

All labels associated with the input obstacle.

See Also:

IlvAnnealingLabelDescriptor.getRelatedObstacle()