com.yworks.graph.input.GraphEditorInputMode

Public Properties

	Property		Defined by
		autoAdjustContentRect : Boolean Gets or sets a property that determines whether this instance should automatically adjust the canvas' `contentRect` if the graph changes.	GraphEditorInputMode
		autoRemoveEmptyLabels : Boolean Gets or sets a value indicating whether this mode should automatically remove labels from the graph when a label text has been edited and the label text is empty.	GraphEditorInputMode
		canvas : CanvasComponent The canvas instance this mode is currently installed in or `null`	AbstractInputMode
		clickInputMode : ClickInputMode The ClickInputMode property.	MainInputMode
		clickModePriority : int The click mode priority.	MainInputMode
		clickSelectableItems : uint Gets or sets a property that determines which types of items should be selectable through mouse clicks.	GraphEditorInputMode
		clipboardOperationsAllowed : Boolean Determines whether clipboard operations with the usual shortcuts are enabled on the canvas.	GraphEditorInputMode
		collectionModel : ICollectionModel Gets or sets the `ICollectionModel` of the `IModelItem` that make up the elements in the view this mode is acting upon.	MainInputMode
		contentRectMargins : ImmutableRectangle Gets or sets the margins to use for `CanvasComponent.updateContentRect()` in `adjustContentRect()` calls.	GraphEditorInputMode
		contextMenuInputMode : ContextMenuInputMode The `contextMenuInputMode` property.	MainInputMode
		contextMenuModePriority : int The context menu mode priority.	MainInputMode
		createBendInputMode : CreateBendInputMode Gets or sets the createBendInputMode property.	GraphEditorInputMode
		createBendModePriority : Number Gets or sets the CreateBendInputModePriority property.	GraphEditorInputMode
		createEdgeInputMode : CreateEdgeInputMode Gets or sets the createEdgeInputMode property.	GraphEditorInputMode
		createEdgeModePriority : Number Gets or sets the CreateEdgeInputModePriority property.	GraphEditorInputMode
		deletableItems : uint Gets or sets a property that determines which types of items may be deleted using the `deleteSelection` action.	GraphEditorInputMode
		deleteElementsAllowed : Boolean Gets or sets the property that determines whether the user is allowed to delete currently selected elements using the Delete key.	GraphEditorInputMode
		detailSelectionRecognizer : Function Gets or sets the event recognizer function that will be queried to decide if a click should select the item that is currently visible under the mouse cursor, without giving more important items higher priority.	GraphEditorInputMode
		graph : IGraph [read-only] Gets the Graph this mode is acting upon.	GraphEditorInputMode
		graphCanvas : GraphCanvasComponent [read-only] Gets the GraphControl this mode is working on or `null.`	GraphEditorInputMode
		graphSelection : IGraphSelection [read-only] Returns the `selectionModel` as an `IGraphSelection`.	GraphEditorInputMode
		groupSelectionAllowed : Boolean Determines whether Ctrl-G-presses should result in calls to `groupSelection()`.	GraphEditorInputMode
		handleInputMode : HandleInputMode The HandleInputMode property.	MainInputMode
		handleModePriority : int The handle mode priority.	MainInputMode
		hitTestIterator : IHitTestIterator Gets or sets the HitTestEnumerator property.	GraphEditorInputMode
		hitTestOrdering : Array Gets or sets the hitTestOrdering.	GraphEditorInputMode
		inputModeCanvasGroup : ICanvasObjectGroup The canvas group that can be used by input modes to add temporary top-level canvas objects to.	MainInputMode
		inputModeContext : IInputModeContext The context instance this mode is currently installed in or `null` if this instance is not installed.	AbstractInputMode
		installed : Boolean Whether this mode is currently installed, i.e.	AbstractInputMode
		keyboardInputMode : KeyboardInputMode The keyboard input mode.	MainInputMode
		keyboardModePriority : int The keyboard mode priority.	MainInputMode
		labelEditingAllowed : Boolean Gets or sets the LabelEditingAllowed property that determines whether the label editor will be automatically invoked if the F2 key is pressed.	GraphEditorInputMode
		marqueeSelectableItems : uint Gets or set a property that determines which types of items should be selected during marquee selections.	GraphEditorInputMode
		marqueeSelectionInputMode : MarqueeSelectionInputMode The MarqueeSelectionInputMode property.	MainInputMode
		marqueeSelectionModePriority : int The marquee selection mode priority.	MainInputMode
		movableItems : uint Gets or sets a property that determines which types of items should movable using the `moveInputMode`.	GraphEditorInputMode
		moveInputMode : MoveInputMode The MoveInputMode property.	MainInputMode
		moveLabelInputMode : MoveLabelInputMode Gets or sets the MoveLabelInputMode property.	GraphEditorInputMode
		moveModePriority : int The move mode priority.	MainInputMode
		nodeCreationAllowed : Boolean Gets or sets whether `createNode` will be called when the canvas is clicked.	GraphEditorInputMode
		nodeCreator : Function Gets or sets the callback that is responsible for creating a new node, e.g.	GraphEditorInputMode
		pasteDelta : IPoint The offset for paste operation if clipboard operations are enabled.	GraphEditorInputMode
		reparentNodeHandler : IReparentNodeHandler ets or sets the reparentNodeHandler property.	GraphEditorInputMode
		reparentNodesAllowed : Boolean Gets or sets a property that determines whether the user may reparent nodes using a move gesture.	GraphEditorInputMode
		selectableItems : uint Gets or sets a property that determines which types of items should be selectable at all.	GraphEditorInputMode
		selectionModel : ISelectionModel Gets or sets the selectionModel property	MainInputMode
		showHandleItems : uint Gets or sets a property that determines which types of items should have their `IHandle`s shown.	GraphEditorInputMode
		textEditorInputMode : TextEditorInputMode Gets or sets the textEditorInputMode property.	GraphEditorInputMode
		textEditorModePriority : Number Gets or sets the TextEditorInputModePriority property.	GraphEditorInputMode
		undoOperationsAllowed : Boolean Determines whether undo/redo operations with the usual shortcuts are enabled on the canvas.	GraphEditorInputMode
		ungroupSelectionAllowed : Boolean Determines whether Ctrl-U-presses should result in calls to `ungroupSelection()`.	GraphEditorInputMode

	Property	Defined by
		inputModeController : InputModeController Gets or sets the input mode controller helper instance.	MainInputMode

	Method	Defined by
		GraphEditorInputMode(graph:IGraph, selectionModel:ISelectionModel) Creates a new instance.	GraphEditorInputMode
		add(inputMode:IInputMode, priority:int = 0):void Adds an input mode using the given priority to this compound mode.	MultiplexingInputMode
		addConcurrent(inputMode:IConcurrentInputMode, priority:int):void Adds an input mode as a concurrent mode using the given priority to this compound mode.	MultiplexingInputMode
		adjustContentRect():void Updates the canvas' `contentRect` using `CanvasComponent#updateContentRect()` and `contentRectMargins`.	GraphEditorInputMode
		adjustCursor():void Adjusts the cursor of the CanvasControl according to the current input mutex owner or the first mode in the list that returns a non-null `preferredCursor`.	MultiplexingInputMode
		cancel():void Cancels all modes.	MultiplexingInputMode
		clearSelection():void Clears the selection on the current `selectionModel`.	MainInputMode
		closeLabelEditor(cancel:Boolean):void Closes the label editor if it is currently open.	GraphEditorInputMode
		copy():void Copies the currently selected elements to the clipboard.	GraphEditorInputMode
		createLabel(labeledItem:ILabeledItem):void Interactively creates a new label for the provided labeled item.	GraphEditorInputMode
		createNode(clickPoint:IPoint):INode Creates a node given a certain click point.	GraphEditorInputMode
		cut():void Cuts and inserts the currently selected elements to the clipboard.	GraphEditorInputMode
		deleteSelection():void This method deletes the currently selected elements.	GraphEditorInputMode
		dispose():void Disposes this input mode.	GraphEditorInputMode
		dragBend(bend:IBend):void Initiates the `handleInputMode` to drag the given bend.	GraphEditorInputMode
		editLabel(label:ILabel):void Triggers the editing of the given label.	GraphEditorInputMode
		findHits(clickPoint:IPoint, tests:Array):IModelItem Used as a callback to find hits underneath a certain clicked point.	GraphEditorInputMode
		getCanvasGroupProvider():ICanvasGroupProvider Returns an `ICanvasGroupProvider` instance for this input mode	MainInputMode
		getMutexOwner():IConcurrentInputMode Finds the `IConcurrentInputMode` that currently owns the mutex or `null.`	MultiplexingInputMode
		groupSelection():void Creates a new group for all of the currently selected elements.	GraphEditorInputMode
		install(context:IInputModeContext):void Installs this mode into the given canvas.	GraphEditorInputMode
		marqueeSelect(marqueeRectangle:IRectangle, items:ICollectionModel):void Selects the given elements in the editor inside the provided marquee selection rectangle.	MainInputMode
		marqueeSelectElements(marqueeRectangle:IRectangle):void This method will marquee select the items in the graph.	GraphEditorInputMode
		paste():void Pastes the current clipboard contents.	GraphEditorInputMode
		redo():void Redoes the last Redoable change.	GraphEditorInputMode
		remove(mode:IInputMode):void Removes the given mode from this compound mode.	MultiplexingInputMode
		selectAll():void Clears the current selection and selects all nodes and bends in this graph.	GraphEditorInputMode
		setLabelText(label:ILabel, text:String):void Sets the label's text after it has been edited using `editLabel`.	GraphEditorInputMode
		setSelected(item:IModelItem, selected:Boolean):void Uses the `selectionModel` to select the given item.	MainInputMode
		sortedModes():List Returns a list of all modes managed by this instance in sorted order.	MultiplexingInputMode
		stop():Boolean Tries to stop all modes.	MultiplexingInputMode
		undo():void Undoes the last undoable change.	GraphEditorInputMode
		ungroupSelection():void Makes each of the currently selected nodes a direct child of the root group (if not already).	GraphEditorInputMode
		uninstall(context:IInputModeContext):void	MultiplexingInputMode

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		childInputModeContextLookup(type:Class):Object Callback lookup method that will be used by the child `IInputModeContext`	GraphEditorInputMode
		createChildInputModeContext():IInputModeContext Callback that creates the `IInputModeContext` for the child modes of this mode.	MultiplexingInputMode
		createClickInputMode():ClickInputMode Factory method for the ClickInputMode property.	MainInputMode
		createContextMenuInputMode():ContextMenuInputMode Factory method for the `contextMenuInputMode` property.	MainInputMode
		createCreateBendInputMode():CreateBendInputMode Factory method for the createBendInputMode property.	GraphEditorInputMode
		createCreateEdgeInputMode():CreateEdgeInputMode Factory method for the createEdgeInputMode property.	GraphEditorInputMode
		createDefaultLabelConfiguration(labeledItem:ILabeledItem):ILabelConfiguration Callback method to create a custom label configuration when a new label should be created.	GraphEditorInputMode
		createHandleInputMode():HandleInputMode Factory method for the HandleInputMode property.	MainInputMode
		createHitTestIterator():IHitTestIterator Factory method for the hitTestEnumerator property.	GraphEditorInputMode
		createInputModeController():InputModeController Creates the `inputModeController` that will be used to coordinate the selection and the handles, etc.	MainInputMode
		createKeyboardInputMode():KeyboardInputMode Factory method that creates the keyboard input mode instance.	MainInputMode
		createMarqueeSelectionInputMode():MarqueeSelectionInputMode Factory method for the `marqueeSelectionInputMode property.`	MainInputMode
		createMoveInputMode():MoveInputMode Factory method for the MoveInputMode property.	GraphEditorInputMode
		createMoveLabelInputMode():MoveLabelInputMode Factory method for the MoveLabelInputMode property.	GraphEditorInputMode
		createReparentNodeHandler():IReparentNodeHandler Factory method for the ReparentNodeHandler property.	GraphEditorInputMode
		createTextEditorInputMode():TextEditorInputMode Factory method for the textEditorInputMode property.	GraphEditorInputMode
		initialize():void Performs one-time initialization of this instance.	GraphEditorInputMode
		invalidate():void Convenience method for subclass implementations that invalidates the canvasComponent this mode is currently installed in.	AbstractInputMode
		onClickInputModeChanged(oldClickInputMode:ClickInputMode, newClickInputMode:ClickInputMode):void Called when the `clickInputMode` property value changes and after initialization of the field.	MainInputMode
		onClickInputModeClicked(evt:ClickEvent):void Called when the mouse has been clicked at a given location.	GraphEditorInputMode
		onCollectionModelChanged(oldCollectionModel:ICollectionModel, newCollectionModel:ICollectionModel):void Callback that gets triggered once the `collectionModel` property changes.	MainInputMode
		onContextMenuInputModeChanged(oldContextMenuInputMode:ContextMenuInputMode, newContextMenuInputMode:ContextMenuInputMode):void Called when the `contextMenuInputMode` property value changes	MainInputMode
		onContextMenuInputModeMenuSelect(evt:CanvasContextMenuEvent):void Callback that is triggered on a `CanvasContextMenuEvent`	GraphEditorInputMode
		onCreateBendInputModeBendCreated(evt:BendCreatedEvent):void Callback that is called as soon as `createBendInputMode` created a new bend.	GraphEditorInputMode
		onCreateBendInputModeChanged(oldCreateBendInputMode:CreateBendInputMode, newCreateBendInputMode:CreateBendInputMode):void Called when the `createBendInputMode` property value changes.	GraphEditorInputMode
		onCreateEdgeInputModeChanged(oldCreateEdgeInputMode:CreateEdgeInputMode, newCreateEdgeInputMode:CreateEdgeInputMode):void Called when the `createEdgeInputMode` property value changes	GraphEditorInputMode
		onCtrlAPressed(evt:KeyboardEvent):void Callback that delegates to `selectAll` if `selectElementsAllowed` is `true`.	GraphEditorInputMode
		onDeletePressed(evt:KeyboardEvent):void Callback that delegates to `deleteSelection` if `deleteElementsAllowed` is `true`.	GraphEditorInputMode
		onEditLabel():void Callback that is invoked if the F2 key is pressed and `labelEditingAllowed` is set to `true`.	GraphEditorInputMode
		onF2KeyPressed(evt:KeyboardEvent):void Callback that triggers `OnEditLabel`.	GraphEditorInputMode
		onGraphCanvasChanged(oldCanvas:GraphCanvasComponent, newCanvas:GraphCanvasComponent):void Called when the `gaphControl` property changes.	GraphEditorInputMode
		onGraphChanged(oldGraph:IGraph, newGraph:IGraph):void Called when the `graph` property changes.	GraphEditorInputMode
		onGraphSelectionChanged(oldSelection:IGraphSelection, newSelection:IGraphSelection):void Called when the `graphSelection` property changes.	GraphEditorInputMode
		onHandleInputModeChanged(oldHandleInputMode:HandleInputMode, newHandleInputMode:HandleInputMode):void Called when the `handleInputMode` property value changes and after initialization of the field.	GraphEditorInputMode
		onInputModeCanvasGroupChanged(oldGroup:ICanvasObjectGroup, newGroup:ICanvasObjectGroup):void Called when the `inputModeCanvasGroup` property changes.	MainInputMode
		onKeyboardInputModeChanged(oldKeyboardInputMode:KeyboardInputMode, newKeyboardInputMode:KeyboardInputMode):void Called when the keyboard input mode changed.	GraphEditorInputMode
		onMarqueeSelectionInputModeChanged(oldMarqueeSelectionInputMode:MarqueeSelectionInputMode, newMarqueeSelectionInputMode:MarqueeSelectionInputMode):void Called when the `marqueeSelectionInputMode` property value changes and after initialization of the field.	MainInputMode
		onMarqueeSelectionInputModeMarqueeSelected(evt:Event):void Callback used by `MarqueeSelectionInputMode` if the user has finished creating the marquee selection.	MainInputMode
		onMoveInputModeChanged(oldMoveInputMode:MoveInputMode, newMoveInputMode:MoveInputMode):void Called when the `moveInputMode` property value changes	GraphEditorInputMode
		onMoveInputModeDragFinished(evt:Event):void Callback method that will be triggered when a drag has been finished.	MainInputMode
		onMoveInputModeMoveFinished(evt:DragEvent):void Called when the a drag operation is finished	GraphEditorInputMode
		onMoveLabelInputModeChanged(oldMoveLabelInputMode:MoveLabelInputMode, newMoveLabelInputMode:MoveLabelInputMode):void Called when the `moveLabelInputMode` property value changes and after initialization of the field.	GraphEditorInputMode
		onReparentNodeHandlerChanged(oldHandler:IReparentNodeHandler, newHandler:IReparentNodeHandler):void Called when the `reparentNodeHandler` property value changes and after initialization of the field.	GraphEditorInputMode
		onSelectionModelChanged(oldSelectionModel:ISelectionModel, newSelectionModel:ISelectionModel):void Callback that gets triggered once the `selectionModel` property changes.	MainInputMode
		onTextEditorInputModeChanged(oldTextEditorInputMode:TextEditorInputMode, newTextEditorInputMode:TextEditorInputMode):void Called when the `textEditorInputMode` property value changes	GraphEditorInputMode
		onTextEditorInputModeTextEdited(evt:Event):void Called when a label's text was edited by the `TextEditorInputMode`	GraphEditorInputMode
		setGraph(newGraph:IGraph):void Set a new Graph for this mode.	GraphEditorInputMode
		setGraphCanvas(graphCanvas:GraphCanvasComponent):void Sets the `GraphCanvasComponent` that is associated with this instance.	GraphEditorInputMode
		setGraphSelection(newSelection:IGraphSelection):void Set a new GraphSelection for this mode.	GraphEditorInputMode
		shouldBeDeleted(item:IModelItem):Boolean Determines whether the item should be deleted.	GraphEditorInputMode
		shouldBeMovable(item:IModelItem):Boolean Determines whether to make the item movable using the `moveInputMode`.	GraphEditorInputMode
		shouldShowHandles(item:IModelItem):Boolean Determines whether to show the handles for the given item.	GraphEditorInputMode

Property detail

autoAdjustContentRect

property

autoAdjustContentRect:Boolean [read-write]

Gets or sets a property that determines whether this instance should automatically adjust the canvas' contentRect if the graph changes.

The adjustContentRect method is called whenever the content changes and autoAdjustContentRect is set to true.

The default value is true.

Implementation
public function get autoAdjustContentRect():Boolean
public function set autoAdjustContentRect(value:Boolean):void

autoRemoveEmptyLabels

property

autoRemoveEmptyLabels:Boolean [read-write]

Gets or sets a value indicating whether this mode should automatically remove labels from the graph when a label text has been edited and the label text is empty.

The default value is false.

Implementation
public function get autoRemoveEmptyLabels():Boolean
public function set autoRemoveEmptyLabels(value:Boolean):void

clickSelectableItems

property

clickSelectableItems:uint [read-write]

Gets or sets a property that determines which types of items should be selectable through mouse clicks.

The default value is GraphItemTypes.ALL.

Implementation
public function get clickSelectableItems():uint
public function set clickSelectableItems(value:uint):void

clipboardOperationsAllowed

property

clipboardOperationsAllowed:Boolean [read-write]

Determines whether clipboard operations with the usual shortcuts are enabled on the canvas.

The default value is true.

Implementation
public function get clipboardOperationsAllowed():Boolean
public function set clipboardOperationsAllowed(value:Boolean):void

contentRectMargins

property

contentRectMargins:ImmutableRectangle [read-write]

Gets or sets the margins to use for CanvasComponent.updateContentRect() in adjustContentRect() calls.

Implementation
public function get contentRectMargins():ImmutableRectangle
public function set contentRectMargins(value:ImmutableRectangle):void

createBendInputMode

property

createBendInputMode:CreateBendInputMode [read-write]

Gets or sets the createBendInputMode property.

If the field has not yet been initialized upon first access, the factory method createCreateBendInputMode will be called. Upon change the onCreateBendInputModeChanged method will be called.

Implementation
public function get createBendInputMode():CreateBendInputMode
public function set createBendInputMode(value:CreateBendInputMode):void

createBendModePriority

property

createBendModePriority:Number [read-write]

Gets or sets the CreateBendInputModePriority property.

The default value is 42.

Implementation
public function get createBendModePriority():Number
public function set createBendModePriority(value:Number):void

createEdgeInputMode

property

createEdgeInputMode:CreateEdgeInputMode [read-write]

Gets or sets the createEdgeInputMode property.

If the field has not yet been initialized upon first access, the factory method createCreateEdgeInputMode will be called. Upon change the onCreateEdgeInputModeChanged method will be called.

Implementation
public function get createEdgeInputMode():CreateEdgeInputMode
public function set createEdgeInputMode(value:CreateEdgeInputMode):void

createEdgeModePriority

property

createEdgeModePriority:Number [read-write]

Gets or sets the CreateEdgeInputModePriority property.

The default value is 45.

Implementation
public function get createEdgeModePriority():Number
public function set createEdgeModePriority(value:Number):void

deletableItems

property

deletableItems:uint [read-write]

Gets or sets a property that determines which types of items may be deleted using the deleteSelection action.

The default value is GraphItemTypes.ALL.

Implementation
public function get deletableItems():uint
public function set deletableItems(value:uint):void

deleteElementsAllowed

property

deleteElementsAllowed:Boolean [read-write]

Gets or sets the property that determines whether the user is allowed to delete currently selected elements using the Delete key.

The default value is true.

Implementation
public function get deleteElementsAllowed():Boolean
public function set deleteElementsAllowed(value:Boolean):void

detailSelectionRecognizer

property

detailSelectionRecognizer:Function [read-write]

Gets or sets the event recognizer function that will be queried to decide if a click should select the item that is currently visible under the mouse cursor, without giving more important items higher priority.

An event recognizer function takes an Event as its only argument and returns a Boolean that indicates whether the event was recognized.

If the value recognizes that the user wanted to use the detail clicking behavior, the hitTestIterator will be queried for the given item and the first item that is returned will be considered a hit. Otherwise all hit items are examined and are priorized by item type. E.g. by default clicking on a node will select the node, even if there is a node label which has been clicked at the same point. If detail selection is recognized, the label will be selected.

The default implementation will recognizer events of type com.yworks.canvas.input.ClickEvent, if the ctrl key was pressed.

Implementation
public function get detailSelectionRecognizer():Function
public function set detailSelectionRecognizer(value:Function):void

graph

property

graph:IGraph [read-only]

Gets the Graph this mode is acting upon.

Implementation
public function get graph():IGraph

graphCanvas

property

graphCanvas:GraphCanvasComponent [read-only]

Gets the GraphControl this mode is working on or null.

his property is set by setGraphControl which is triggered if this mode is installed in a GraphCanvasComponent.


   Implementation


    public function get graphCanvas():GraphCanvasComponent





graphSelection property  



graphSelection:IGraphSelection  [read-only]
   Returns the selectionModel as an IGraphSelection.
   
Implementation


    public function get graphSelection():IGraphSelection






groupSelectionAllowed property  



groupSelectionAllowed:Boolean  [read-write]
   Determines whether Ctrl-G-presses should result in calls to groupSelection().
   
The default value is true.
Implementation


    public function get groupSelectionAllowed():Boolean


    public function set groupSelectionAllowed(value:Boolean):void



See also


groupSelection()





hitTestIterator property  



hitTestIterator:IHitTestIterator  [read-write]
   Gets or sets the HitTestEnumerator property. 
   

   The enumerator will be queried for hit tests if the user clicks on the canvas.
   If the field has not yet been initialized upon first access, the
   factory method createHitTestEnumerator will be called.
   
   Implementation


    public function get hitTestIterator():IHitTestIterator


    public function set hitTestIterator(value:IHitTestIterator):void






hitTestOrdering property  



hitTestOrdering:Array  [read-write]
      Gets or sets the hitTestOrdering. 
      

      The hitTestOrdering is an array of HitTest constants that determines 
      the ordering in which items are tested for click hits.
      
      Implementation


    public function get hitTestOrdering():Array


    public function set hitTestOrdering(value:Array):void






labelEditingAllowed property  



labelEditingAllowed:Boolean  [read-write]
   Gets or sets the LabelEditingAllowed property that determines whether the label editor
   will be automatically invoked if the F2 key is pressed.
   

   If this flag is set to true pressing F2 will start the label editor.
   
   The default value is true.
Implementation


    public function get labelEditingAllowed():Boolean


    public function set labelEditingAllowed(value:Boolean):void



See also


onEditLabel


editLabel





marqueeSelectableItems property  



marqueeSelectableItems:uint  [read-write]
   Gets or set a property that determines which types of 
   items should be selected during marquee selections.
   
The default value is A combination of GraphItemTypes.NODE, GraphItemTypes.EDGE and GraphItemTypes.BEND..
Implementation


    public function get marqueeSelectableItems():uint


    public function set marqueeSelectableItems(value:uint):void



See also


com.yworks.graph.model.GraphItemTypes


marqueeSelectElements()





movableItems property  



movableItems:uint  [read-write]
      Gets or sets a property that determines which types of 
      items should movable using the moveInputMode.
      
The default value is GraphItemTypes.ALL.
Implementation


    public function get movableItems():uint


    public function set movableItems(value:uint):void



See also


com.yworks.graph.model.GraphItemTypes


shouldBeMovable()

MainInputMode.moveInputMode




moveLabelInputMode property  



moveLabelInputMode:MoveLabelInputMode  [read-write]
      Gets or sets the MoveLabelInputMode property.
      

      This mode is responsible for moving labels to another candidate position.
      If the field has not yet been initialized upon first access, the factory method createMoveLabelInputMode 
      will be called. Upon change the onMoveLabelInputModeChanged method will be called.
      
      Implementation


    public function get moveLabelInputMode():MoveLabelInputMode


    public function set moveLabelInputMode(value:MoveLabelInputMode):void






nodeCreationAllowed property  



nodeCreationAllowed:Boolean  [read-write]
   Gets or sets whether createNode will be called
   when the canvas is clicked. 
   
Implementation


    public function get nodeCreationAllowed():Boolean


    public function set nodeCreationAllowed(value:Boolean):void



See also


createNode


nodeCreator





nodeCreator property  



nodeCreator:Function  [read-write]
   Gets or sets the callback that is responsible for creating a new node, e.g.
   in response to a mouse click.
   

   The node creator function has to take the current context and IGraph instance 
   and the IPoint location as arguments, and returns the created node: 
   
   var nodeCreator:Function = function( context:IInputModeContext, graph:IGraph, location:IPoint ):INode {
     var node:INode = ..
     ..
     return node;
   }
   
   
   Implementation


    public function get nodeCreator():Function


    public function set nodeCreator(value:Function):void






pasteDelta property  



pasteDelta:IPoint  [read-write]
   The offset for paste operation if clipboard operations are enabled.
   
The default value is (15, 15).
Implementation


    public function get pasteDelta():IPoint


    public function set pasteDelta(value:IPoint):void






reparentNodeHandler property  



reparentNodeHandler:IReparentNodeHandler  [read-write]
   ets or sets the reparentNodeHandler property.
   

   This handler will be delegated to by an implementation of the
   IReparentNodeHandler interface that this class
   puts into the childInputModeContextLookup.

   The child input modes will query this interface to perform node reparenting operations
   if the graph is an IGroupedGraph.
   If the field has not yet been initialized upon first access, the
   factory method createReparentNodeHandler will be called.
   Upon change the onReparentNodeHandlerChanged method will be called.
   
   Implementation


    public function get reparentNodeHandler():IReparentNodeHandler


    public function set reparentNodeHandler(value:IReparentNodeHandler):void



See also


reparentNodesAllowed


createReparentNodeHandler()


onReparentNodeHandlerChanged





reparentNodesAllowed property  



reparentNodesAllowed:Boolean  [read-write]
   Gets or sets a property that determines whether the user
   may reparent nodes using a move gesture.
   

   This setting is only of relevance if the graph is a hierarchic graph.
   This setting overrides the currently set reparentNodeHandler if set to false.
   
   The default value is true.
Implementation


    public function get reparentNodesAllowed():Boolean


    public function set reparentNodesAllowed(value:Boolean):void



See also


reparentNodeHandler


com.yworks.graph.model.IGroupedGraph





selectableItems property  



selectableItems:uint  [read-write]
      Gets or sets a property that determines which types of 
      items should be selectable at all.
      
The default value is GraphItemTypes.ALL.
Implementation


    public function get selectableItems():uint


    public function set selectableItems(value:uint):void



See also


com.yworks.graph.model.GraphItemTypes





showHandleItems property  



showHandleItems:uint  [read-write]
      Gets or sets a property that determines which types of 
      items should have their IHandles shown.
      
The default value is GraphItemTypes.ALL.
Implementation


    public function get showHandleItems():uint


    public function set showHandleItems(value:uint):void



See also


com.yworks.graph.model.GraphItemTypes


com.yworks.canvas.input.IHandle


shouldShowHandles()





textEditorInputMode property  



textEditorInputMode:TextEditorInputMode  [read-write]
      Gets or sets the textEditorInputMode property.
      

      If the field has not yet been initialized upon first access, the
      factory method createTextEditorInputMode will be called.
      Upon change the onTextEditorInputModeChanged method will be called.
      
      Implementation


    public function get textEditorInputMode():TextEditorInputMode


    public function set textEditorInputMode(value:TextEditorInputMode):void






textEditorModePriority property  



textEditorModePriority:Number  [read-write]
      Gets or sets the TextEditorInputModePriority property.
      
The default value is 100.
Implementation


    public function get textEditorModePriority():Number


    public function set textEditorModePriority(value:Number):void






undoOperationsAllowed property  



undoOperationsAllowed:Boolean  [read-write]
   Determines whether undo/redo operations with the usual shortcuts are enabled on the canvas.
   
The default value is true.
Implementation


    public function get undoOperationsAllowed():Boolean


    public function set undoOperationsAllowed(value:Boolean):void






ungroupSelectionAllowed property  



ungroupSelectionAllowed:Boolean  [read-write]
   Determines whether Ctrl-U-presses should result in calls to ungroupSelection().
   
The default value is true.
Implementation


    public function get ungroupSelectionAllowed():Boolean


    public function set ungroupSelectionAllowed(value:Boolean):void



See also


ungroupSelection()



Constructor detail



GraphEditorInputMode () constructor



public function GraphEditorInputMode(graph:IGraph, selectionModel:ISelectionModel)
   Creates a new instance.
   
Parameters


graph:IGraph — The IGraph to work on.
   


 


selectionModel:ISelectionModel — The ISelectionModel to work with.
   



See also


com.yworks.graph.model.IGraph


com.yworks.graph.model.ISelectionModel



Method detail



adjustContentRect () method



public function adjustContentRect():void
   Updates the canvas' contentRect using 
   CanvasComponent#updateContentRect() and
   contentRectMargins.
   

   This method is called whenever the content changes and autoAdjustContentRect
   is set to true.
   
   
See also


contentRectMargins


com.yworks.canvas.CanvasComponent.updateContentRect()





childInputModeContextLookup () method  



protected override function childInputModeContextLookup(type:Class):Object
   
      Callback lookup method that will be used by the child IInputModeContext
      
Parameters


type:Class — The class to lookup
      



Returns


Object — An implementation of the given type, or null
      






closeLabelEditor () method  



public function closeLabelEditor(cancel:Boolean):void
      Closes the label editor if it is currently open.
      
Parameters


cancel:Boolean — Whether to cancel the editor and discard changes.
      






copy () method  



public function copy():void
   Copies the currently selected elements to the clipboard.
   



createCreateBendInputMode () method  



protected function createCreateBendInputMode():CreateBendInputMode
      Factory method for the createBendInputMode property.
      

      This method will be called
      upon first access to the createBendInputMode property.
      
      
Returns


CreateBendInputMode — 
                        A new instance of CreateBendInputMode.
      
                        
                     






createCreateEdgeInputMode () method  



protected function createCreateEdgeInputMode():CreateEdgeInputMode
      Factory method for the createEdgeInputMode property.
      

      This method will be called 
      upon first access to the createEdgeInputMode property.
      
      
Returns


CreateEdgeInputMode — 
                        A new instance of CreateEdgeInputMode.
      
                        
                     






createDefaultLabelConfiguration () method  



protected function createDefaultLabelConfiguration(labeledItem:ILabeledItem):ILabelConfiguration
      Callback method to create a custom label configuration when a new label should be created.
      
Parameters


labeledItem:ILabeledItem — the item a new label will be created for.
      



Returns


ILabelConfiguration — 
                        A default label configuration
      
                        
                     






createHitTestIterator () method  



protected function createHitTestIterator():IHitTestIterator

yFiles FLEX 1.3 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class GraphEditorInputMode	Properties \| Methods

Package	com.yworks.graph.input
Class	public class GraphEditorInputMode
Inheritance	GraphEditorInputMode MainInputMode MultiplexingInputMode AbstractInputMode flash.events.EventDispatcher

	`graph:IGraph` — The `IGraph` to work on.

	`selectionModel:ISelectionModel` — The `ISelectionModel` to work with.