CreateBendInputMode

An IInputMode used for recognizing the gesture of creating IBends in an IGraph.

Inheritance Hierarchy

CreateBendInputMode

Implemented Interfaces

Remarks

This mode is used by GraphEditorInputMode but can be used stand-alone, too. Client code should register with the BendCreated event to perform additional actions after the bend has been created.

This mode is exclusive by default.

Examples

Typically the CreateBendInputMode is installed as child mode of a GraphEditorInputMode and can be retrieved from the createBendInputMode property.

Getting the CreateBendInputMode from its parent input mode

const createBendInputMode = mode.createBendInputMode

Type Details

yfiles module: view-editor
yfiles-umd modules: view-editor, view-table, view
Legacy UMD name: yfiles.input.CreateBendInputMode

Constructors

CreateBendInputMode

()

Creates a new instance that will use the IGraph from the inputModeContext to create bends in.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

priority - number

exclusive - boolean

A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.

enabled - boolean

The enabled state of this input mode. This option sets the enabled property on the created object.

armedCursor - Cursor

The cursor to use when this mode is in "armed" state. This option sets the armedCursor property on the created object.

pressedRecognizer - function(Object, EventArgs):boolean

An event recognizer that determines when the user begins to move the selection. This option sets the pressedRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

draggedRecognizer - function(Object, EventArgs):boolean

An event recognizer that determines when the user is moving the selection. This option sets the draggedRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

releasedRecognizer - function(Object, EventArgs):boolean

An event recognizer that determines when the user has finished the move. This option sets the releasedRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

prepareRecognizerTouch - function(Object, EventArgs):boolean

An event recognizer that determines when the user begins to move the selection via touch. This option sets the prepareRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

movedRecognizerTouch - function(Object, EventArgs):boolean

An event recognizer that determines when the user begins actually moves the selection via touch. This option sets the movedRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

releasedRecognizerTouch - function(Object, EventArgs):boolean

An event recognizer that determines when the finalized the gesture via touch. This option sets the releasedRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

beginHitTestable - IHitTestable

The IHitTestable that determines where bends may be created. This option sets the beginHitTestable property on the created object.

splitOrthogonalSegmentRecognizer - function(Object, EventArgs):boolean

An event recognizer that determines whether the bend creation should be treated as a split segment operation. This option sets the splitOrthogonalSegmentRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

splitOrthogonalSegment - boolean

A value indicating whether an orthogonal segment should be split by the last bend creation. This option sets the splitOrthogonalSegment property on the created object.

useExistingBend - boolean

A property that determines whether this mode should use an existing bend in createBend if there is one found at the given location. This option sets the useExistingBend property on the created object.

Properties

armedCursor

: Cursor

Gets or sets the cursor to use when this mode is in "armed" state.

beginHitTestable

: IHitTestable

Gets or sets the IHitTestable that determines where bends may be created.

controller

: ConcurrencyController

Gets the installed controller.

draggedRecognizer

: function(any, EventArgs):boolean

Gets or sets an event recognizer that determines when the user is moving the selection.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

enabled

: boolean

Gets or sets the enabled state of this input mode.

Remarks

Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed controller so a disabled instance should never try to acquire the input mutex.

Examples

Disabling the CreateBendInputMode on its parent input mode

mode.createBendInputMode.enabled = false

Note that in order to disable interactive bend creation one has to disable bend creation during edge creation, too:

Disabling the bend creation during edge creation and on existing edges

// mode is an instance of GraphEditorInputMode
mode.createBendInputMode.enabled = false
mode.createEdgeInputMode.allowCreateBend = false

exclusive

: boolean

Gets or sets a value indicating whether this mode will be the only one running when it has the mutex.

Remarks

The value of this property will be delegated to the exclusive property of the controller.

If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.

graph

: IGraph

Gets the graph this mode is acting upon.

inputModeContext

: IInputModeContext

Gets the context instance this mode is currently installed in or null if this instance is not installed.

Remarks

Note that this instance should not be passed down to subordinate modes or instances. Instead a corresponding context that has this instance set as the parentInputMode should be used.

Implements

IInputMode

location

: Point

Gets the location where the bend creation gesture was initialized.

movedRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets an event recognizer that determines when the user begins actually moves the selection via touch.

Remarks

The default value is TOUCH_MOVE_PRIMARY.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

prepareRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets an event recognizer that determines when the user begins to move the selection via touch.

Remarks

The default value is TOUCH_LONG_PRESS_PRIMARY.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

pressedRecognizer

: function(any, EventArgs):boolean

Gets or sets an event recognizer that determines when the user begins to move the selection.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

priority

: number

Gets the priority of this input mode.

Remarks

The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.

Implements

IInputMode

releasedRecognizer

: function(any, EventArgs):boolean

Gets or sets an event recognizer that determines when the user has finished the move.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

releasedRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets an event recognizer that determines when the finalized the gesture via touch.

Remarks

The default value is TOUCH_UP_PRIMARY.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

splitOrthogonalSegment

: boolean

Gets or sets a value indicating whether an orthogonal segment should be split by the last bend creation.

Remarks

This property can be read by implementations of IBendCreator if they retrieve this instance from their parentInputMode. If this property is true, implementation are advised to treat the bend creation as a gesture that splits the segment into two.

splitOrthogonalSegmentRecognizer

: function(any, EventArgs):boolean

Gets or sets an event recognizer that determines whether the bend creation should be treated as a split segment operation.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

useExistingBend

: boolean

Gets or sets a property that determines whether this mode should use an existing bend in createBend if there is one found at the given location.

Remarks

The default is true

Methods

arm

()

Called when a bend creation gesture can be started at the current mouse pointer location.

Remarks

This implementation sets the preferredCursor to armedCursor.

cancel

()

Cancels the editing of this mode.

Remarks

This implementation releases the mutex if it is currently owned by this instance and calls onCanceled.

Implements

IInputMode

createBend

(edge: IEdge, location: Point) : IBend

Creates the bend.

Remarks

The bend is created using the hit edge's IBendCreator implementation, as obtained from the edge's lookup.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The hit edge.
location - Point: The coordinates of the hit.

Returns

↪IBend: The created bend or null.

createInputModeContext

() : IInputModeContext

Creates an IInputModeContext for use with the upcoming createBend call in createBend.

Returns

↪IInputModeContext: An instance of IInputModeContext.

disarm

()

Called when a bend creation gesture can no longer be started at the current mouse pointer location.

Remarks

This implementation sets the preferredCursor back to null.

dragSegment

(edge: IEdge, dragLocation: Point)

Updates the splitOrthogonalSegment property and then delegates to createBend.

Remarks

This method triggers the BendCreated event if a bend is created.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to create a bend for.
dragLocation - Point: The location at which the user initiated the gesture.

getEdge

(location: Point) : IEdge

Finds the edge at the given coordinate.

Parameters

options - Object
A map of options to pass to the method.

location - Point: The coordinates.

Returns

↪IEdge: The edge that has been hit.

install

(context: IInputModeContext, controller: ConcurrencyController)

Installs this mode into the given context that is provided by the canvas.

Remarks

In general a mode can only be installed into a single canvas at all times.

This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.

Overriding implementations should call the base implementation, first.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context that this instance shall be installed into. The same instance will be passed to this instance during uninstall. A reference to the context may be kept and queried during the time the mode is installed.
controller - ConcurrencyController: The controller for this mode.

Implements

IInputMode

isValidBegin

(source: Object, evt: EventArgs) : boolean

Determines whether the current location is valid to begin a bend creation gesture.

onBendCreated

(evt: BendEventArgs)

Triggers the BendCreated event.

onCanceled

()

Called after cancel has been called.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been canceled.

This implementation does nothing.

onConcurrencyControllerActivated

()

Called after the active property of the installed ConcurrencyController has been set to true.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been activated.

Overriding implementations should call the base implementation.

onConcurrencyControllerDeactivated

()

Called after the active property of the installed ConcurrencyController has been set to false.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been deactivated.

Overriding implementations should call the base implementation.

onDragCanceled

(evt: InputModeEventArgs)

Triggers the DragCanceled event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragged

(evt: InputModeEventArgs)

Triggered at the end of each drag.

Remarks

This method triggers the Dragged event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onDragging

(evt: InputModeEventArgs)

Triggered at the start of each drag.

Remarks

This method triggers the Dragging event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

onStopped

()

Called after tryStop has been called.

Remarks

Can be overridden in subclasses to perform additional actions after the mode has been stopped.

This implementation does nothing.

tryStop

() : boolean

Called by the client in order to stop a current editing progress.

Remarks

This should stop the current edit, if one is in progress and possibly commit all of the changes. If stopping is not possible, this method can return false

Returns

↪boolean: true if and only if the editing has been stopped or there was no edit in progress

Implements

IInputMode

uninstall

(context: IInputModeContext)

Uninstalls this mode from the given context.

Remarks

This code should clean up all changes made to the canvas in the install method. After a mode has been uninstalled it can be installed again into the same or another canvas.

Overriding implementations should call the base implementation after their own code.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context to deregister from. This is the same instance that had been passed to install during installation.

Implements

IInputMode

Events

BendCreated

Occurs once a bend creation gesture has been recognized.

Event Registration

addBendCreatedListener(function(this, BendEventArgs):void)

Event Deregistration

removeBendCreatedListener(function(this, BendEventArgs):void)

Signature Details

function(sender: this, evt: BendEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - BendEventArgs: An object that contains the event data.

DragCanceled

Occurs when the drag has been canceled.

Event Registration

addDragCanceledListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDragCanceledListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

Dragged

Occurs at the end of every drag.

Event Registration

addDraggedListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDraggedListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

Dragging

Occurs at the start of every drag.

Event Registration

addDraggingListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDraggingListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

CreateBendInputMode

Remarks

Examples

Type Details

Constructors

CreateBendInputMode

ParametersOptions Overload

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

Signature Details

Parameters

Returns

See Also

Properties

armedCursor

beginHitTestable

controller

draggedRecognizer

Signature Details

Parameters

Returns

enabled

Remarks

Examples

exclusive

Remarks

graph

inputModeContext

Remarks

Implements

location

movedRecognizerTouch

Remarks

Signature Details

Parameters

Returns

prepareRecognizerTouch

Remarks

Signature Details

Parameters

Returns

pressedRecognizer

Signature Details

Parameters

Returns

priority

Remarks

See Also

Implements

releasedRecognizer

Signature Details

Parameters

Returns

releasedRecognizerTouch

Remarks

Signature Details

Parameters

Returns

splitOrthogonalSegment

Remarks

See Also

splitOrthogonalSegmentRecognizer

Signature Details

Parameters