com.yworks.yfiles.layout

Class ExtendedEdgeLabelCandidate

java.lang.Object

com.yworks.yfiles.layout.LabelCandidate

com.yworks.yfiles.layout.EdgeLabelCandidate

com.yworks.yfiles.layout.ExtendedEdgeLabelCandidate

All Implemented Interfaces:

IPlaneObject

public class ExtendedEdgeLabelCandidate
extends EdgeLabelCandidate

An EdgeLabelCandidate that provides a candidate descriptor.

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
ExtendedEdgeLabelCandidate(YOrientedRectangle orientedBox, Object param, IEdgeLabelLayout owner, boolean internal, ILabelCandidateDescriptor descriptor) Returns a new instance of ExtendedEdgeLabelCandidate.
ExtendedEdgeLabelCandidate(YPoint pos, YDimension size, Object param, IEdgeLabelLayout owner, boolean internal, ILabelCandidateDescriptor descriptor) Returns a new instance of ExtendedEdgeLabelCandidate.
ExtendedEdgeLabelCandidate(YPoint pos, YDimension size, Object param, IEdgeLabelLayout owner, ILabelCandidateDescriptor descriptor) Returns a new instance of ExtendedEdgeLabelCandidate.

Method Summary

Modifier and Type	Method and Description
ILabelCandidateDescriptor	getDescriptor() Gets the label candidate descriptor.

Methods inherited from class com.yworks.yfiles.layout.LabelCandidate

getBoundingBox, getBox, getCustomProfit, getEdgeOverlapPenalty, getHeight, getLocation, getModelParameter, getNodeOverlapPenalty, getOverlapPenalty, getOwner, getSize, getWidth, getX, getY, isInternal, isPropagated, propagate, setCustomProfit, setEdgeOverlapPenalty, setNodeOverlapPenalty, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedEdgeLabelCandidate

public ExtendedEdgeLabelCandidate(YOrientedRectangle orientedBox,
                                  Object param,
                                  IEdgeLabelLayout owner,
                                  boolean internal,
                                  ILabelCandidateDescriptor descriptor)

Returns a new instance of ExtendedEdgeLabelCandidate.

Returns a new instance of ExtendedEdgeLabelCandidate.

Parameters:

orientedBox - the label size and orientation

param - the parameters of the labeling model associated with this candidate.

owner - the label associated to the candidate.

internal - flag whether the candidate is allowed to overlap the layout of the edge.

descriptor - the label candidate descriptor.

ExtendedEdgeLabelCandidate

public ExtendedEdgeLabelCandidate(YPoint pos,
                                  YDimension size,
                                  Object param,
                                  IEdgeLabelLayout owner,
                                  boolean internal,
                                  ILabelCandidateDescriptor descriptor)

Returns a new instance of ExtendedEdgeLabelCandidate.

Returns a new instance of ExtendedEdgeLabelCandidate.

Parameters:

pos - the location of the upper left corner of the candidate.

size - the size of the candidate.

param - the parameters of the labeling model associated with this candidate.

owner - the label associated to the candidate.

internal - flag whether the candidate is allowed to overlap the layout of the edge.

descriptor - the label candidate descriptor.

ExtendedEdgeLabelCandidate

public ExtendedEdgeLabelCandidate(YPoint pos,
                                  YDimension size,
                                  Object param,
                                  IEdgeLabelLayout owner,
                                  ILabelCandidateDescriptor descriptor)

Returns a new instance of ExtendedEdgeLabelCandidate.

Returns a new instance of ExtendedEdgeLabelCandidate.

Parameters:

pos - the location of the upper left corner of the candidate.

size - the size of the candidate.

param - the parameters of the labeling model associated with this candidate.

owner - the label associated to the candidate.

descriptor - the label candidate descriptor.

Method Detail

getDescriptor

public final ILabelCandidateDescriptor getDescriptor()

Gets the label candidate descriptor.

Returns:

The Descriptor.