com.yworks.yfiles.server.graphml.flexio.data
Class RotatingEdgeLabelModel

java.lang.Object
  extended bycom.yworks.yfiles.server.graphml.flexio.data.RotatingEdgeLabelModel
All Implemented Interfaces:
ILabelModel

public class RotatingEdgeLabelModel
extends java.lang.Object
implements ILabelModel

Data object for the yFiles FLEX client's rotating edge label model


Nested Class Summary
static class RotatingEdgeLabelModel.ModelParameter
           
 
Constructor Summary
RotatingEdgeLabelModel()
           
 
Method Summary
 ILabelModelParameter createDefaultParameter()
          Creates a default parameter that can be used for this model.
 double getAngle()
          The angle of the label relative to the edge's path.
 double getDistance()
          Gets or sets a property that determines the distance between the label's center and the anchor point on the edge's path.
 boolean isEdgeRelativeDistance()
          A property that determines how the distance value should be interpreted.
 void setAngle(double angle)
          The angle of the label relative to the edge's path.
 void setDistance(double distance)
          Gets or sets a property that determines the distance between the label's center and the anchor point on the edge's path.
 void setEdgeRelativeDistance(boolean edgeRelativeDistance)
          A property that determines how the distance value should be interpreted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RotatingEdgeLabelModel

public RotatingEdgeLabelModel()
Method Detail

createDefaultParameter

public ILabelModelParameter createDefaultParameter()
Description copied from interface: ILabelModel
Creates a default parameter that can be used for this model.

Specified by:
createDefaultParameter in interface ILabelModel
Returns:
A parameter for this model instance.

getAngle

public double getAngle()
The angle of the label relative to the edge's path.


setAngle

public void setAngle(double angle)
The angle of the label relative to the edge's path.


getDistance

public double getDistance()
Gets or sets a property that determines the distance between the label's center and the anchor point on the edge's path.

A distance of 0 makes the label appear centered on the edge's path. Depending on the value of the edgeRelativeDistance property, the distance is interpreted differently: If the distance is interpreted relatively, a positive distance makes the label appear at the left hand of the edge. If the distance is interpreted absolutely, positive values make the label appear on top of the edge's path, while negative values make it appear below the path.

See Also:
#edgeRelativeDistance

setDistance

public void setDistance(double distance)
Gets or sets a property that determines the distance between the label's center and the anchor point on the edge's path.

A distance of 0 makes the label appear centered on the edge's path. Depending on the value of the edgeRelativeDistance property, the distance is interpreted differently: If the distance is interpreted relatively, a positive distance makes the label appear at the left hand of the edge. If the distance is interpreted absolutely, positive values make the label appear on top of the edge's path, while negative values make it appear below the path.

See Also:
setEdgeRelativeDistance(boolean)

isEdgeRelativeDistance

public boolean isEdgeRelativeDistance()
A property that determines how the distance value should be interpreted.

If the distance is interpreted relatively, a positive distance makes the label appear at the left hand of the edge. If the distance is interpreted absolutely, positive values make the label appear on top of the edge's path, while negative values make it appear below the path.

See Also:
getDistance()

setEdgeRelativeDistance

public void setEdgeRelativeDistance(boolean edgeRelativeDistance)
A property that determines how the distance value should be interpreted.

If the distance is interpreted relatively, a positive distance makes the label appear at the left hand of the edge. If the distance is interpreted absolutely, positive values make the label appear on top of the edge's path, while negative values make it appear below the path.

See Also:
getDistance()


Copyright © 2000-2013 yWorks GmbH. All rights reserved