Packagecom.yworks.yfiles.layout
Classpublic class EdgeLabelCandidate
InheritanceEdgeLabelCandidate Inheritance LabelCandidate Inheritance YObject Inheritance Object
Subclasses ExtendedEdgeLabelCandidate

A candidate position for edge labels


Public Properties
 PropertyDefined By
 InheritedboundingBox : YRectangle
[read-only] Returns the bounding box of this label candidate.
LabelCandidate
 Inheritedbox : YOrientedRectangle
[read-only] Returns the real bounds of this label candidate.
LabelCandidate
 InheritedcustomProfit : Number
Specifies the custom profit for this label candidate.
LabelCandidate
 InheritededgeOverlapPenalty : Number
Specifies the penalty value for a candidate position that overlaps the path of an edge.
LabelCandidate
 Inheritedheight : Number
[read-only] Returns the height of the label candidate bounds.
LabelCandidate
 Inheritedinternal2 : Boolean
[read-only] Returns whether this candidate is an internal node label, i.e.
LabelCandidate
 Inheritedlocation : YPoint
[read-only] Returns the upper left corner of the label candidate bounds.
LabelCandidate
 InheritedmodelParameter : Object
[read-only] Returns the model parameter that was used by the underlying model to generate this label candidate.
LabelCandidate
 InheritednodeOverlapPenalty : Number
Specifies the penalty for a candidate position that overlaps the bounds of a node.
LabelCandidate
 InheritedoverlapPenalty : Number
[read-only] Returns the sum of node overlap penalty and edge overlap penalty.
LabelCandidate
 Inheritedowner : LabelLayout
[read-only] Returns the LabelLayout to which this candidate box belongs.
LabelCandidate
 Inheritedparameter : Object
[read-only] Returns the model parameter that was used by the underlying model to generate this label candidate.
LabelCandidate
 Inheritedpropagated : Boolean
[read-only] Returns if this box had been chosen by the labeling algorithm.
LabelCandidate
 Inheritedsize : YDimension
[read-only] Returns the width and height of the label candidate bounds.
LabelCandidate
 Inheritedwidth : Number
[read-only] Returns the width of the label candidate bounds.
LabelCandidate
 Inheritedx : Number
[read-only] Returns the minimal x-coordinate of the label candidate bounds.
LabelCandidate
 Inheritedy : Number
[read-only] Returns the minimal y-coordinate of the label candidate bounds.
LabelCandidate
Public Methods
 MethodDefined By
  
EdgeLabelCandidate(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, init:Boolean = true)
Returns a new instance of EdgeLabelCandidate.
EdgeLabelCandidate
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
EdgeLabelCandidate
 Inherited
hashCode():int
YObject
  
newEdgeLabelCandidate1(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout):EdgeLabelCandidate
[static] Returns a new instance of EdgeLabelCandidate.
EdgeLabelCandidate
  
newEdgeLabelCandidate2(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, _internal:Boolean):EdgeLabelCandidate
[static] Returns a new instance of EdgeLabelCandidate.
EdgeLabelCandidate
  
newEdgeLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout):EdgeLabelCandidate
[static] Returns a new instance of LabelCandidate.
EdgeLabelCandidate
  
newEdgeLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout, _internal:Boolean):EdgeLabelCandidate
[static] Returns a new instance of EdgeLabelCandidate.
EdgeLabelCandidate
 Inherited
newLabelCandidate1(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout):LabelCandidate
[static] Returns a new instance of LabelCandidate.
LabelCandidate
 Inherited
newLabelCandidate2(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout, _internal:Boolean):LabelCandidate
[static] Returns a new instance of LabelCandidate.
LabelCandidate
 Inherited
newLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout):LabelCandidate
[static] Returns a new instance of LabelCandidate.
LabelCandidate
 Inherited
newLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout, _internal:Boolean):LabelCandidate
[static] Returns a new instance of LabelCandidate.
LabelCandidate
 Inherited
propagate():void
Sets the model parameters of the owner of this label candidate to the model parameters of this candidate box.
LabelCandidate
 Inherited
toString():String
LabelCandidate
Protected Methods
 MethodDefined By
  
initEdgeLabelCandidate1(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout):void
Initializes this object.
EdgeLabelCandidate
  
initEdgeLabelCandidate2(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, _internal:Boolean):void
Initializes this object.
EdgeLabelCandidate
  
initEdgeLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout):void
Initializes this object.
EdgeLabelCandidate
  
initEdgeLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout, _internal:Boolean):void
Initializes this object.
EdgeLabelCandidate
 Inherited
initLabelCandidate1(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout):void
Initializes this object.
LabelCandidate
 Inherited
initLabelCandidate2(labelBox:YOrientedRectangle, param:Object, owner:LabelLayout, _internal:Boolean):void
Initializes this object.
LabelCandidate
 Inherited
initLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout):void
Initializes this object.
LabelCandidate
 Inherited
initLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:LabelLayout, _internal:Boolean):void
Initializes this object.
LabelCandidate
Constructor Detail
EdgeLabelCandidate()Constructor
public function EdgeLabelCandidate(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, init:Boolean = true)

Returns a new instance of EdgeLabelCandidate.

Parameters
orientedBox:YOrientedRectangle — the box that specifies the candidate's size and position.
 
param:Object — the parameters of the labeling model associated with this candidate.
 
owner:EdgeLabelLayout — the label associated to the candidate.
 
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
getClass()method
override public function getClass():Class

Returns
Class
initEdgeLabelCandidate1()method 
protected final function initEdgeLabelCandidate1(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout):void

Initializes this object. See the documentation of the corresponding factory method newEdgeLabelCandidate1() for details.

Parameters

orientedBox:YOrientedRectangle
 
param:Object
 
owner:EdgeLabelLayout

See also

newEdgeLabelCandidate1()
initEdgeLabelCandidate2()method 
protected final function initEdgeLabelCandidate2(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, _internal:Boolean):void

Initializes this object. See the documentation of the corresponding factory method newEdgeLabelCandidate2() for details.

Parameters

orientedBox:YOrientedRectangle
 
param:Object
 
owner:EdgeLabelLayout
 
_internal:Boolean

See also

newEdgeLabelCandidate2()
initEdgeLabelCandidate3()method 
protected final function initEdgeLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout):void

Initializes this object. See the documentation of the corresponding factory method newEdgeLabelCandidate3() for details.

Parameters

pos:YPoint
 
size:YDimension
 
param:Object
 
owner:EdgeLabelLayout

See also

newEdgeLabelCandidate3()
initEdgeLabelCandidate4()method 
protected final function initEdgeLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout, _internal:Boolean):void

Initializes this object. See the documentation of the corresponding factory method newEdgeLabelCandidate4() for details.

Parameters

pos:YPoint
 
size:YDimension
 
param:Object
 
owner:EdgeLabelLayout
 
_internal:Boolean

See also

newEdgeLabelCandidate4()
newEdgeLabelCandidate1()method 
public static function newEdgeLabelCandidate1(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout):EdgeLabelCandidate

Returns a new instance of EdgeLabelCandidate.

Parameters

orientedBox:YOrientedRectangle — the box that specifies the candidate's size and position.
 
param:Object — the parameters of the labeling model associated with this candidate.
 
owner:EdgeLabelLayout — the label associated to the candidate.

Returns
EdgeLabelCandidate
newEdgeLabelCandidate2()method 
public static function newEdgeLabelCandidate2(orientedBox:YOrientedRectangle, param:Object, owner:EdgeLabelLayout, _internal:Boolean):EdgeLabelCandidate

Returns a new instance of EdgeLabelCandidate.

Parameters

orientedBox:YOrientedRectangle — the box that specifies the candidate's size and position.
 
param:Object — the parameters of the labeling model associated with this candidate.
 
owner:EdgeLabelLayout — the label associated to the candidate.
 
_internal:Boolean — flag whether the candidate is allowed to overlap the layout of the associated edge.

Returns
EdgeLabelCandidate
newEdgeLabelCandidate3()method 
public static function newEdgeLabelCandidate3(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout):EdgeLabelCandidate

Returns a new instance of LabelCandidate.

Parameters

pos:YPoint — the location of the upper left corner of the candidate.
 
size:YDimension — the size of the candidate.
 
param:Object — the parameters of the labeling model associated with this candidate.
 
owner:EdgeLabelLayout — the label associated to the candidate.

Returns
EdgeLabelCandidate
newEdgeLabelCandidate4()method 
public static function newEdgeLabelCandidate4(pos:YPoint, size:YDimension, param:Object, owner:EdgeLabelLayout, _internal:Boolean):EdgeLabelCandidate

Returns a new instance of EdgeLabelCandidate.

Parameters

pos:YPoint — the location of the upper left corner of the candidate.
 
size:YDimension — the size of the candidate.
 
param:Object — the parameters of the labeling model associated with this candidate.
 
owner:EdgeLabelLayout — the label associated to the candidate.
 
_internal:Boolean — flag whether the candidate is allowed to overlap the layout of the associated edge.

Returns
EdgeLabelCandidate




Wed Oct 7 2015, 04:43 PM +02:00