com.yworks.yfiles.graph.labelmodels

Class LabelCandidateDescriptor

java.lang.Object

com.yworks.yfiles.graph.labelmodels.LabelCandidateDescriptor

All Implemented Interfaces:

ILabelCandidateDescriptor

public class LabelCandidateDescriptor
extends Object
implements ILabelCandidateDescriptor

A simple mutable default implementation of the ILabelCandidateDescriptor interface.

All properties are read/write in this implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static ILabelCandidateDescriptor	EXTERNAL_DESCRIPTOR A sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields true for the ExternalCandidate property.
static ILabelCandidateDescriptor	INTERNAL_DESCRIPTOR A sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields false for the ExternalCandidate property.

Constructor Summary

Constructors

Constructor and Description
LabelCandidateDescriptor()

Method Summary

Modifier and Type	Method and Description
double	getEdgeOverlapPenalty() Gets a penalty value that is used by labeling algorithms to judge the severity if this candidate overlaps with an edge path.
double	getNodeOverlapPenalty() Gets a penalty value that is used by labeling algorithms to judge the severity if this label candidate overlaps with a node's bounds.
double	getProfit() Gets a profit value that is used by labeling algorithms to judge how good this label candidate is.
boolean	isExternalCandidate() Gets a value indicating whether this candidate is deemed an external candidate.
void	setEdgeOverlapPenalty(double value) Sets a penalty value that is used by labeling algorithms to judge the severity if this candidate overlaps with an edge path.
void	setExternalCandidate(boolean value) Sets a value indicating whether this candidate is deemed an external candidate.
void	setNodeOverlapPenalty(double value) Sets a penalty value that is used by labeling algorithms to judge the severity if this label candidate overlaps with a node's bounds.
void	setProfit(double value) Sets a profit value that is used by labeling algorithms to judge how good this label candidate is.

Methods inherited from class java.lang.Object

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

Field Detail

EXTERNAL_DESCRIPTOR

public static final ILabelCandidateDescriptor EXTERNAL_DESCRIPTOR

A sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields true for the ExternalCandidate property.

INTERNAL_DESCRIPTOR

public static final ILabelCandidateDescriptor INTERNAL_DESCRIPTOR

A sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields false for the ExternalCandidate property.

Constructor Detail

LabelCandidateDescriptor

public LabelCandidateDescriptor()

Method Detail

getEdgeOverlapPenalty

public final double getEdgeOverlapPenalty()

Description copied from interface: ILabelCandidateDescriptor

Gets a penalty value that is used by labeling algorithms to judge the severity if this candidate overlaps with an edge path.

This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.

Specified by:

getEdgeOverlapPenalty in interface ILabelCandidateDescriptor

Returns:

The edge overlap penalty.

getNodeOverlapPenalty

public final double getNodeOverlapPenalty()

Description copied from interface: ILabelCandidateDescriptor

Gets a penalty value that is used by labeling algorithms to judge the severity if this label candidate overlaps with a node's bounds.

This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.

Specified by:

getNodeOverlapPenalty in interface ILabelCandidateDescriptor

Returns:

The node overlap penalty.

getProfit

public final double getProfit()

Description copied from interface: ILabelCandidateDescriptor

Gets a profit value that is used by labeling algorithms to judge how good this label candidate is.

This value must be between 0 and 1 (inclusive). Higher profit means better candidates. Hence, there is a higher probability that the candidate is chosen by a labeling algorithm.

Specified by:

getProfit in interface ILabelCandidateDescriptor

Returns:

The profit to be used by labeling algorithms.

isExternalCandidate

public final boolean isExternalCandidate()

Description copied from interface: ILabelCandidateDescriptor

Gets a value indicating whether this candidate is deemed an external candidate.

This is mainly for INode labels that are a visual part of the node's internals. It could be used for edge labels, too, if the edge occupies significant amounts of visual space.

Specified by:

isExternalCandidate in interface ILabelCandidateDescriptor

Returns:

true if this describes an external candidate; false otherwise.

setEdgeOverlapPenalty

public final void setEdgeOverlapPenalty(double value)

Sets a penalty value that is used by labeling algorithms to judge the severity if this candidate overlaps with an edge path.

This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.

Parameters:

value - The edge overlap penalty.

See Also:

getEdgeOverlapPenalty()

setExternalCandidate

public final void setExternalCandidate(boolean value)

Sets a value indicating whether this candidate is deemed an external candidate.

This is mainly for INode labels that are a visual part of the node's internals. It could be used for edge labels, too, if the edge occupies significant amounts of visual space.

Parameters:

value - true if this describes an external candidate; false otherwise.

See Also:

isExternalCandidate()

setNodeOverlapPenalty

public final void setNodeOverlapPenalty(double value)

Sets a penalty value that is used by labeling algorithms to judge the severity if this label candidate overlaps with a node's bounds.

This value must be between 0 and 1 (inclusive). A value of 0 means that an overlap is considered not important, while a value of 1 means that an overlap is considered severe.

Parameters:

value - The node overlap penalty.

See Also:

getNodeOverlapPenalty()

setProfit

public final void setProfit(double value)

Sets a profit value that is used by labeling algorithms to judge how good this label candidate is.

This value must be between 0 and 1 (inclusive). Higher profit means better candidates. Hence, there is a higher probability that the candidate is chosen by a labeling algorithm.

Parameters:

value - The profit to be used by labeling algorithms.

See Also:

getProfit()