com.yworks.yfiles.layout

Class EdgeLabelCandidate

java.lang.Object

com.yworks.yfiles.layout.LabelCandidate

com.yworks.yfiles.layout.EdgeLabelCandidate

All Implemented Interfaces:

IPlaneObject

Direct Known Subclasses:

ExtendedEdgeLabelCandidate

public class EdgeLabelCandidate
extends LabelCandidate

An EdgeLabelCandidate describes one valid placement for an edge label considering the label model.

Constructor Summary

Constructors

Constructor and Description
EdgeLabelCandidate(YOrientedRectangle labelBox, Object param, IEdgeLabelLayout owner) Creates a new instance of EdgeLabelCandidate described by its box, model parameter and internal flag.
EdgeLabelCandidate(YOrientedRectangle labelBox, Object param, IEdgeLabelLayout owner, boolean internal) Creates a new instance of EdgeLabelCandidate described by its box, model parameter and internal flag.
EdgeLabelCandidate(YPoint pos, YDimension size, Object param, IEdgeLabelLayout owner) Creates a new instance of EdgeLabelCandidate described by location, size, model parameter and internal flag.
EdgeLabelCandidate(YPoint pos, YDimension size, Object param, IEdgeLabelLayout owner, boolean internal) Creates a new instance of EdgeLabelCandidate described by location, size, model parameter and internal flag.

Method Summary

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

EdgeLabelCandidate

public EdgeLabelCandidate(YOrientedRectangle labelBox,
                          Object param,
                          IEdgeLabelLayout owner)

Creates a new instance of EdgeLabelCandidate described by its box, model parameter and internal flag.

Parameters:

labelBox - the box that specifies the candidate's size and position

param - the parameters of the label model associated with this candidate

owner - the label associated with the candidate

EdgeLabelCandidate

public EdgeLabelCandidate(YOrientedRectangle labelBox,
                          Object param,
                          IEdgeLabelLayout owner,
                          boolean internal)

Creates a new instance of EdgeLabelCandidate described by its box, model parameter and internal flag.

Parameters:

labelBox - the box that specifies the candidate's size and position

param - the parameters of the label model associated with this candidate

owner - the label associated with the candidate

internal - true if the candidate is allowed to overlap with its owner, false otherwise

EdgeLabelCandidate

public EdgeLabelCandidate(YPoint pos,
                          YDimension size,
                          Object param,
                          IEdgeLabelLayout owner)

Creates a new instance of EdgeLabelCandidate described by location, size, model parameter and internal flag.

Parameters:

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

size - the size of the candidate

param - the parameters of the label model associated with this candidate

owner - the label associated with the candidate

EdgeLabelCandidate

public EdgeLabelCandidate(YPoint pos,
                          YDimension size,
                          Object param,
                          IEdgeLabelLayout owner,
                          boolean internal)

Creates a new instance of EdgeLabelCandidate described by location, size, model parameter and internal flag.

Parameters:

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

size - the size of the candidate

param - the parameters of the label model associated with this candidate

owner - the label associated with the candidate

internal - true if the candidate is allowed to overlap with its owner, false otherwise