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 bend-created 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

Constructors

CreateBendInputMode

()

Creates a new instance that will use the IGraph from the parentInputModeContext 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.

validBeginRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines whether the current location is valid to begin a bend creation gesture. This option sets the validBeginRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

beginRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines when the user begins bend creation. This option sets the beginRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

moveRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines when the user is moving the new bend. This option sets the moveRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

finishRecognizer - function(EventArgs, unknown):boolean

The event recognizer that determines when the user has finished bend creation. This option sets the finishRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

beginRecognizerTouch - function(EventArgs, unknown):boolean

An event recognizer that determines when the user begins bend creation via TOUCH input. This option sets the beginRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

moveRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines when the user moves the new bend via TOUCH input. This option sets the moveRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

finishRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines when the user has finished bend creation via TOUCH input. This option sets the finishRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

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(EventArgs, unknown):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(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

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.

beginRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines when the user begins bend creation.

Remarks

The default recognizer detects MOUSE or PEN DOWN events.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

beginRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets an event recognizer that determines when the user begins bend creation via TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_LONG_PRESS.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

controller

: ConcurrencyController?

Gets the installed controller.

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.

finishRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines when the user has finished bend creation.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

finishRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines when the user has finished bend creation via TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_UP.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

graph

: IGraph?

Gets the graph this mode is acting upon.

location

: Point

Gets the location where the bend creation gesture was initialized.

moveRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines when the user is moving the new bend.

Remarks

The default recognizer is MOUSE_DRAG.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

moveRecognizerTouch

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines when the user moves the new bend via TOUCH input.

Remarks

The default recognizer is TOUCH_PRIMARY_DRAG.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

parentInputModeContext

: IInputModeContext?

Retrieves the IInputModeContext this mode has been installed in.

Remarks

The value will be null if this mode is currently not installed. Use createInputModeContext to obtain a context that has this IInputMode as the inputMode.

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 CanvasComponent. The lower the priority value, the earlier it will be installed. If two modes are using the same priority value, the first one to be registered will be installed earlier.

Implements

IInputMode

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 inputMode. If this property is true, implementations are advised to treat the bend creation as a gesture that splits the segment into two.

splitOrthogonalSegmentRecognizer

: function(EventArgs, unknown):boolean

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

Property Value

The event recognizer that determines whether orthogonal edge segments should be split during the bend creation.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

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

validBeginRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether the current location is valid to begin a bend creation gesture.

Remarks

The default recognizer is ALWAYS.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

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.

createBendCreatorInputModeContext

() : IInputModeContext

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

Returns

↪IInputModeContext: An instance of IInputModeContext.

createInputModeContext

() : IInputModeContext

Creates an implementation of IInputModeContext that is specific to this mode.

Remarks

This is needed for events that are triggered by this InputMode to signal where the event is coming from. A common usage for this is, for example, in isHit calls.

The result can be given to isHit or enumerateHits to let implementations of IHitTestable get access to the current IInputModeContext. This can be done by looking up IInputModeContext from the ICanvasContext's lookup method or simply downcasting.

Returns

↪IInputModeContext: A readily configured 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 bend-created 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 coordinates.

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

onBendCreated

(evt: InputModeItemEventArgs<IBend>)

Triggers the bend-created event.

Parameters

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

evt - InputModeItemEventArgs<IBend>: The event argument holding the bend.

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 drag-canceled 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

Will be called to request a stop of the current editing progress.

Remarks

This should stop the current edit, if one is in progress, and possibly commit all pending 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

'bend-created'

: function(InputModeItemEventArgs<IBend>, this):void

Occurs once a bend has been interactively created by this input mode.

'drag-canceled'

: function(InputModeEventArgs, this):void

Occurs when the drag has been canceled.

'dragged'

: function(InputModeEventArgs, this):void

Occurs at the end of every drag.

'dragging'

: function(InputModeEventArgs, this):void

Occurs at the start of every drag.

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

Signature Details

Parameters

Returns

See Also

Properties

armedCursor

beginHitTestable

beginRecognizer

Remarks

Signature Details

Parameters

Returns

beginRecognizerTouch

Remarks

Signature Details

Parameters

Returns

controller

enabled

Remarks

Examples

exclusive

Remarks

finishRecognizer

Signature Details

Parameters

Returns

finishRecognizerTouch

Remarks

Signature Details

Parameters

Returns

graph

location

moveRecognizer

Remarks

Signature Details

Parameters

Returns

moveRecognizerTouch

Remarks

Signature Details

Parameters

Returns

parentInputModeContext

Remarks

priority

Remarks

Implements

splitOrthogonalSegment

Remarks

See Also