com.yworks.yfiles.layout

Class ExtendedLabelCandidateProfitModel

java.lang.Object

com.yworks.yfiles.layout.ExtendedLabelCandidateProfitModel

All Implemented Interfaces:

IProfitModel

public class ExtendedLabelCandidateProfitModel
extends Object
implements IProfitModel

An IProfitModel that returns the profit of a label candidate for instances of ExtendedNodeLabelCandidate and ExtendedEdgeLabelCandidate.

This class is used by LayoutExecutor and LayoutGraphAdapter to convert an IGraph into a corresponding Graph. Unless that conversion needs to be customized, or aforementioned classes cannot be used, this class usually doesn't need to be used explicitly.

Constructor Summary

Constructors

Constructor and Description
ExtendedLabelCandidateProfitModel()

Method Summary

Modifier and Type	Method and Description
double	getProfit(LabelCandidate candidate) Returns the profit for placing a label-candidate.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedLabelCandidateProfitModel

public ExtendedLabelCandidateProfitModel()

Method Detail

getProfit

public final double getProfit(LabelCandidate candidate)

Returns the profit for placing a label-candidate.

This implementation returns the profit for instances of ExtendedNodeLabelCandidate or 0.0 for other LabelCandidates.

Specified by:

getProfit in interface IProfitModel

Parameters:

candidate - a label candidate

Returns:

a value between 0 and 1.