Packagecom.yworks.graph.model
Interfacepublic interface IChangeDummyEdgeAppearanceCallback extends IChangeLabeledItemAppearanceCallback

The interface of the callback that is passed to implementations of the IDummyEdgeConverter's changeDummyEdgeAppearance() and createDummyEdgeAppearance() methods.

This interface can be used by the IDummyEdgeConverter implementations to adjust the appearance of the DummyEdgeId in a IFoldedGraph view. Modifying the view state of a dummy edge through this interface will prevent the undo queue from being corrupted and is the only way of modifying a dummy edge that is not currently being displayed in any view.

See also

IChangeLabeledItemAppearanceCallback
FoldingManager.getChangeDummyAppearanceCallback()

Public Methods
 MethodDefined By
  
addBend(index:int, x:Number, y:Number):IBend
Performs the IGraph#addBend() operation for the edge that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
 Inherited
addLabel(labelModelParameter:ILabelModelParameter, style:ILabelStyle, text:String, preferredWidth:Number, preferredHeight:Number):ILabel
Performs the IGraph#addLabel() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
clearBends():void
Performs the IGraph#clearBends() operation for the edge that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
 Inherited
clearLabels():void
Convenience method that removes all labels from the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
removeBend(bend:IBend):void
Performs the IGraph#removeBend() operation for the item that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
 Inherited
removeLabel(label:ILabel):void
Performs the IGraph#removeLabel() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
setBendLocation(bend:IBend, x:Number, y:Number):void
Performs the IGraph#setBendLocation() operation for the given bend at the item that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
  
setBendTag(index:int, newTag:Object):void
Sets the user tag of the dummy bend with the given index of the dummy edge.
IChangeDummyEdgeAppearanceCallback
 Inherited
setLabelModelParameter(label:ILabel, parameter:ILabelModelParameter):void
Performs the IGraph#setLabelModelParameter() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
 Inherited
setLabelStyle(label:ILabel, style:ILabelStyle):void
Performs the IGraph#setLabelStyle() operation for the provided label that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
 Inherited
setLabelTag(label:ILabel, newTag:Object):void
Sets the tag for the label of the item that that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
 Inherited
setLabelText(label:ILabel, text:String):void
Performs the IGraph#setLabelText() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
 Inherited
setPreferredSize(label:ILabel, width:Number, height:Number):void
Performs the IGraph#setPreferredSize() operation for the item that this callback has been configured for.
IChangeLabeledItemAppearanceCallback
  
setSourcePortLocationParameter(parameter:IPortLocationModelParameter):void
Performs the IGraph#setPortLocationParameter() operation for the source port of the edge that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
  
setSourcePortStyle(portStyle:IPortStyle):void
Performs the IGraph#setPortStyle() operation for the source port of the edge that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
  
setSourcePortTag(newTag:Object):void
Sets the user tag of the source port of the dummy edge.
IChangeDummyEdgeAppearanceCallback
  
setStyle(edgeStyle:IEdgeStyle):void
Performs the IGraph#setEdgeStyle() operation for the edge that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
  
setTag(newTag:Object):void
Sets the user tag of the dummy edge The tag can differ from the original edge's tag especially if the dummy edge represents more than one edge.
IChangeDummyEdgeAppearanceCallback
  
setTargetPortLocationParameter(parameter:IPortLocationModelParameter):void
Performs the IGraph#setPortLocationParameter() operation for the target port of the edge that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
  
setTargetPortStyle(portStyle:IPortStyle):void
Performs the IGraph#setPortStyle() operation for the target port of the edge that this callback has been configured for.
IChangeDummyEdgeAppearanceCallback
  
setTargetPortTag(newTag:Object):void
Sets the user tag of the target port of the dummy edge.
IChangeDummyEdgeAppearanceCallback
Method Detail
addBend()method
public function addBend(index:int, x:Number, y:Number):IBend

Performs the IGraph#addBend() operation for the edge that this callback has been configured for.

Parameters

index:int — The index where the new bend needs to be inserted.
 
x:Number — The x coordinate of the bend position.
 
y:Number — The y coordinate of the bend position.

Returns
IBend — The new bend for this dummy edge.

See also

IGraph.addBend()
clearBends()method 
public function clearBends():void

Performs the IGraph#clearBends() operation for the edge that this callback has been configured for.

See also

IGraph.clearBends()
removeBend()method 
public function removeBend(bend:IBend):void

Performs the IGraph#removeBend() operation for the item that this callback has been configured for.

Parameters

bend:IBend — The bend instance to remove.

See also

IGraph.removeBend()
setBendLocation()method 
public function setBendLocation(bend:IBend, x:Number, y:Number):void

Performs the IGraph#setBendLocation() operation for the given bend at the item that this callback has been configured for.

Parameters

bend:IBend — The bend instance to set the location.
 
x:Number — The new x coordinate of the bend.
 
y:Number — The new y coordinate of the bend. IGraph#setBendLocation()

setBendTag()method 
public function setBendTag(index:int, newTag:Object):void

Sets the user tag of the dummy bend with the given index of the dummy edge.

The tag can differ from the original bend's tag especially if the dummy edge represents more than one edge. Although the bend's tag can be written using the ITagOwner found in the bend's lookup(), this method should be used instead to ensure that if this interface is used to modify the appearance of a dummy edge's bends no undo units are enqueued.

Parameters

index:int — The bend's index.
 
newTag:Object

See also

com.yworks.support.ITagOwner.tag
setSourcePortLocationParameter()method 
public function setSourcePortLocationParameter(parameter:IPortLocationModelParameter):void

Performs the IGraph#setPortLocationParameter() operation for the source port of the edge that this callback has been configured for.

Parameters

parameter:IPortLocationModelParameter — the new location parameters

Since the IEdge#sourcePort of a dummy edge can be a dummy item and a dummy edge needs to be connected to a dummy port if the actual source node is not currently visible, this method can be used to relocate the source port of the dummy edge that does not connect to the true master source node.

See also

IGraph.setPortLocationParameter()
setSourcePortStyle()method 
public function setSourcePortStyle(portStyle:IPortStyle):void

Performs the IGraph#setPortStyle() operation for the source port of the edge that this callback has been configured for.

Parameters

portStyle:IPortStyle — The new style for the port.

Since the IEdge#sourcePort of a dummy edge is always a dummy item and each dummy edge is connected to its own set of source and target ports, this method can be used to reassign the style of the source port of the dummy edge.

See also

IGraph.setPortStyle()
setSourcePortTag()method 
public function setSourcePortTag(newTag:Object):void

Sets the user tag of the source port of the dummy edge.

The tag can differ from the original edge's source port tag especially if the dummy edge represents more than one edge. Although the port's tag can be written using the ITagOwner found in the port's lookup(), this method should be used instead to ensure that if this interface is used to modify the appearance of a dummy edge's ports no undo units are enqueued.

Parameters

newTag:Object

See also

com.yworks.support.ITagOwner.tag
setStyle()method 
public function setStyle(edgeStyle:IEdgeStyle):void

Performs the IGraph#setEdgeStyle() operation for the edge that this callback has been configured for.

Parameters

edgeStyle:IEdgeStyle — The new edge style.

See also

Igraph.setEdgeStyle()
setTag()method 
public function setTag(newTag:Object):void

Sets the user tag of the dummy edge

The tag can differ from the original edge's tag especially if the dummy edge represents more than one edge. Although the edge's tag can be written using the ITagOwner found in the edge's lookup(), this method should be used instead to ensure that if this interface is used to modify the appearance of a dummy edge no undo units are enqueued.

Parameters

newTag:Object — The new tag.

See also

com.yworks.support.ITagOwner.tag
setTargetPortLocationParameter()method 
public function setTargetPortLocationParameter(parameter:IPortLocationModelParameter):void

Performs the IGraph#setPortLocationParameter() operation for the target port of the edge that this callback has been configured for.

Parameters

parameter:IPortLocationModelParameter — the new location parameters

Since the IEdge.TargetPort of a dummy edge is always a dummy item and each dummy edge is connected to its own set of source and target ports, this method can be used to relocate the target port of the dummy edge.

See also

IGraph.setPortLocationParameter()
setTargetPortStyle()method 
public function setTargetPortStyle(portStyle:IPortStyle):void

Performs the IGraph#setPortStyle() operation for the target port of the edge that this callback has been configured for.

Parameters

portStyle:IPortStyle — The new style for the port.

Since the IEdge#targetPort of a dummy edge is always a dummy item and each dummy edge is connected to its own set of source and target ports, this method can be used to reassign the style of the target port of the dummy edge.

See also

setPortStyle()
setTargetPortTag()method 
public function setTargetPortTag(newTag:Object):void

Sets the user tag of the target port of the dummy edge.

The tag can differ from the original edge's target port tag especially if the dummy edge represents more than one edge. Although the port's tag can be written using the ITagOwner found in the port's lookup(), this method should be used instead to ensure that if this interface is used to modify the appearance of a dummy edge's ports no undo units are enqueued.

Parameters

newTag:Object

See also

com.yworks.support.ITagOwner.tag




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