Packagecom.yworks.graph.input.snapLines
Classpublic class CollectSnapLinesEvent
InheritanceCollectSnapLinesEvent Inheritance SnapContextEvent Inheritance flash.events.Event

The event used by GraphSnapContext to collect the various snap lines for each drag.

See also

GraphSnapContext.collectNodeSnapLines
GraphSnapContext.collectEdgeSnapLines
GraphSnapContext.collectNodePairCenterSnapLines
GraphSnapContext.collectNodePairSegmentSnapLines
GraphSnapContext.collectNodePairSnapLines
GraphSnapContext.collectPortSnapLines


Public Properties
 PropertyDefined By
  context : IInputModeContext
[read-only] Gets the context for the current event.
CollectSnapLinesEvent
Public Methods
 MethodDefined By
  
CollectSnapLinesEvent(type:String, context:IInputModeContext, fixedNodeSnapLines:Collection, fixedSegmentSnapLines:Collection, fixedPortSnapLines:Collection, additionalSnapLines:Collection, bubbles:Boolean = false, cancelable:Boolean = false)
Constructs a new instance of the CollectSnapLineEvent class.
CollectSnapLinesEvent
  
Add another additional snap line to which both nodes and segments can snap to.
CollectSnapLinesEvent
  
Add another fixed node snap line.
CollectSnapLinesEvent
  
Add another snap line for fixed edge segments.
CollectSnapLinesEvent
  
addPortSnapLine(snapLine:SnapLine):void
Add another snap line for ports.
CollectSnapLinesEvent
  
clone():Event
[override]
CollectSnapLinesEvent
Public Constants
 ConstantDefined By
 InheritedCLEANED_UP : String = cleanedUp
[static] Dispatched when the SnapContext has cleaned up itself.
SnapContextEvent
  COLLECT_SNAP_LINES : String = com.yworks.graph.input.snapLines.CollectSnapLinesEvent.collectSnapLines
[static]
CollectSnapLinesEvent
 InheritedINITIALIZED : String = initialized
[static] Dispatched when a drag in the SnapContext has been initialized.
SnapContextEvent
 InheritedINITIALIZING : String = initializing
[static] Dispatched when the SnapContext has started to initialize a drag.
SnapContextEvent
Property Detail
contextproperty
context:IInputModeContext  [read-only]

Gets the context for the current event.


Implementation
    public function get context():IInputModeContext
Constructor Detail
CollectSnapLinesEvent()Constructor
public function CollectSnapLinesEvent(type:String, context:IInputModeContext, fixedNodeSnapLines:Collection, fixedSegmentSnapLines:Collection, fixedPortSnapLines:Collection, additionalSnapLines:Collection, bubbles:Boolean = false, cancelable:Boolean = false)

Constructs a new instance of the CollectSnapLineEvent class.

Parameters
type:String — The event type.
 
context:IInputModeContext — The context where the event is being used in.
 
fixedNodeSnapLines:Collection — The fixed node snap lines collection to add to.
 
fixedSegmentSnapLines:Collection — The fixed segment snap lines collection to add to.
 
fixedPortSnapLines:Collection — The fixed segment snap lines collection to add to.
 
additionalSnapLines:Collection — The additional snap lines collection to add to.
 
bubbles:Boolean (default = false) — Whether the event bubbles.
 
cancelable:Boolean (default = false) — Whether the event is cancelable.
Method Detail
addAdditionalSnapLine()method
public function addAdditionalSnapLine(snapLine:SnapLine):void

Add another additional snap line to which both nodes and segments can snap to.

Parameters

snapLine:SnapLine — The snap line to add to the list of lines that all elements snap to by default.

See also

addFixedNodeSnapLine()method 
public function addFixedNodeSnapLine(snapLine:SnapLine):void

Add another fixed node snap line.

Parameters

snapLine:SnapLine — The snap line to add to the list of lines that nodes snap to by default.

See also

addFixedSegmentSnapLine()method 
public function addFixedSegmentSnapLine(snapLine:SnapLine):void

Add another snap line for fixed edge segments.

Parameters

snapLine:SnapLine — The snap line to add to the list of lines that segments snap to by default.

See also

addPortSnapLine()method 
public function addPortSnapLine(snapLine:SnapLine):void

Add another snap line for ports.

Parameters

snapLine:SnapLine — The snap line to add to the list of lines that nodes snap to by default.

See also

clone()method 
override public function clone():Event

Returns
Event
Constant Detail
COLLECT_SNAP_LINESConstant
public static const COLLECT_SNAP_LINES:String = com.yworks.graph.input.snapLines.CollectSnapLinesEvent.collectSnapLines