com.yworks.yfiles.view.input

Interface IInputModeContext

All Superinterfaces:

ICanvasContext, ILookup

public interface IInputModeContext
extends ICanvasContext

The interface for the context object that is passed to IInputMode instances during IInputMode.install(IInputModeContext, ConcurrencyController) and IInputMode.uninstall(IInputModeContext) and IDragHandler implementations like IPositionHandler and IHandle to provide additional context for the implementations.

Implementations of this interface can carry additional information through their ILookup.lookup(java.lang.Class) method.

See Also:

ILookup, IInputMode

Field Summary

Fields

Modifier and Type	Field and Description
static IInputModeContext	EMPTY An empty context where both the inputmode and the canvas is null.

Fields inherited from interface com.yworks.yfiles.view.ICanvasContext

DEFAULT

Method Summary

Modifier and Type	Method and Description
static IInputModeContext	create(CanvasControl canvas) Factory method that creates an IInputModeContext that uses the provided values.
static IInputModeContext	create(CanvasControl canvas, IInputMode parent) Factory method that creates an IInputModeContext that uses the provided values.
static IInputModeContext	create(CanvasControl canvas, IInputMode parent, ILookup lookup) Factory method that creates an IInputModeContext that uses the provided values.
static IInputModeContext	create(IInputMode parent) Factory method that creates an IInputModeContext that uses the provided parent mode and lookup decoration.
static IInputModeContext	create(IInputMode parent, IContextLookup lookupCallback) Factory method that creates an IInputModeContext that uses the provided parent mode and lookup decoration.
static IInputModeContext	create(IInputMode parent, IInputModeContext parentContext, IContextLookup lookupCallback) Factory method that creates an IInputModeContext that uses the provided parent mode, parent context, and lookup decoration.
static IInputModeContext	create(IInputMode parent, IInputModeContext parentContext, ILookup lookup) Factory method that creates an IInputModeContext that uses the provided parent mode, parent context, and lookup decoration.
static IInputModeContext	create(IInputMode parent, ILookup lookup) Factory method that creates an IInputModeContext that uses the provided parent mode and lookup decoration.
default IFoldingView	getFoldingView() Tries to retrieve an IFoldingView instance from the IInputModeContext.
default IGraph	getGraph() Tries to retrieve an IGraph instance from the IInputModeContext.
default IGraphSelection	getGraphSelection() Tries to retrieve an IGraphSelection instance from the IInputModeContext.
IInputMode	getParentInputMode() Yields the IInputMode which issued the context object.
default void	invalidateDisplays() Tries to call IGraph.invalidateDisplays() on the graph from the IInputModeContext.

Methods inherited from interface com.yworks.yfiles.view.ICanvasContext

create, create, getCanvasControl, getHitTestRadius, getZoom

Methods inherited from interface com.yworks.yfiles.graph.ILookup

createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, lookup, safeLookup

Field Detail

EMPTY

static final IInputModeContext EMPTY

An empty context where both the inputmode and the canvas is null.

The lookup always yields null, also.

Method Detail

create

static IInputModeContext create(CanvasControl canvas)

Factory method that creates an IInputModeContext that uses the provided values.

Specified by:

create in interface ICanvasContext

Parameters:

canvas - The CanvasControl to use, may not be null.

create

static IInputModeContext create(CanvasControl canvas,
                                IInputMode parent)

Factory method that creates an IInputModeContext that uses the provided values.

Parameters:

canvas - The CanvasControl to use, may not be null.

parent - The mode to set as the parent. This may be null for the canvas' context.

create

static IInputModeContext create(CanvasControl canvas,
                                IInputMode parent,
                                ILookup lookup)

Factory method that creates an IInputModeContext that uses the provided values.

Parameters:

canvas - The CanvasControl to use, may not be null.

parent - The mode to set as the parent. This may be null for the canvas' context.

lookup - The lookup to use.

create

static IInputModeContext create(IInputMode parent)

Factory method that creates an IInputModeContext that uses the provided parent mode and lookup decoration.

create

static IInputModeContext create(IInputMode parent,
                                IContextLookup lookupCallback)

Factory method that creates an IInputModeContext that uses the provided parent mode and lookup decoration.

create

static IInputModeContext create(IInputMode parent,
                                IInputModeContext parentContext,
                                IContextLookup lookupCallback)

Factory method that creates an IInputModeContext that uses the provided parent mode, parent context, and lookup decoration.

create

static IInputModeContext create(IInputMode parent,
                                IInputModeContext parentContext,
                                ILookup lookup)

Factory method that creates an IInputModeContext that uses the provided parent mode, parent context, and lookup decoration.

create

static IInputModeContext create(IInputMode parent,
                                ILookup lookup)

Factory method that creates an IInputModeContext that uses the provided parent mode and lookup decoration.

getFoldingView

default IFoldingView getFoldingView()

Tries to retrieve an IFoldingView instance from the IInputModeContext.

This will use the ILookup of the context or if nothing is found the lookup of the graph in the context.

Returns:

The instance or null.

getGraph

default IGraph getGraph()

Tries to retrieve an IGraph instance from the IInputModeContext.

This will use the ILookup and if this yields nothing, it will use the ILookup of the CanvasControl or finally test if it is a GraphControl to obtain the graph from.

Returns:

Return the graph or null.

getGraphSelection

default IGraphSelection getGraphSelection()

Tries to retrieve an IGraphSelection instance from the IInputModeContext.

This will use the ILookup and if this yields nothing, it will use the ILookup of the CanvasControl or finally test if it is a GraphControl to obtain the selection from.

Returns:

Return the selection or null.

getParentInputMode

IInputMode getParentInputMode()

Yields the IInputMode which issued the context object.

This can be null if this context is used outside the context of an IInputMode.

Returns:

The ParentInputMode.

invalidateDisplays

default void invalidateDisplays()

Tries to call IGraph.invalidateDisplays() on the graph from the IInputModeContext.

If the graph instance cannot be found, CanvasControl.invalidate() will be called instead.