com.yworks.yfiles.view

Interface ICanvasContext

All Superinterfaces:

ILookup

All Known Subinterfaces:

IInputModeContext, IRenderContext

public interface ICanvasContext
extends ILookup

This interface describes the context for many operations performed on items in a CanvasControl.

This interface extends the ILookup interface to provide dynamic lookup capability.

Field Summary

Fields

Modifier and Type	Field and Description
static ICanvasContext	DEFAULT Provides a default immutable context with a hit radius of 3 and a zoom level of 1.

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

EMPTY

Method Summary

Modifier and Type	Method and Description
static ICanvasContext	create(CanvasControl canvas) Provides a default immutable ICanvasContext with the given values.
static ICanvasContext	create(CanvasControl canvas, double zoom) Provides a default immutable ICanvasContext with the given values.
static ICanvasContext	create(CanvasControl canvas, double zoom, double hitTestRadius) Provides a default immutable ICanvasContext with the given values.
CanvasControl	getCanvasControl() Yields the Canvas that is associated with this context.
double	getHitTestRadius() The radius for hit tests and marquee selection tests in world coordinates.
double	getZoom() Returns the current zoom level that is the ratio of world coordinates to screen pixels.

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

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

Field Detail

DEFAULT

static final ICanvasContext DEFAULT

Provides a default immutable context with a hit radius of 3 and a zoom level of 1.

Method Detail

create

static ICanvasContext create(CanvasControl canvas)

Provides a default immutable ICanvasContext with the given values.

If the values for zoom or hitTestRadius are not specified, the values will be obtained from the given canvas.

Parameters:

canvas - the canvas

create

static ICanvasContext create(CanvasControl canvas,
                             double zoom)

Provides a default immutable ICanvasContext with the given values.

If the values for zoom or hitTestRadius are not specified, the values will be obtained from the given canvas.

Parameters:

canvas - the canvas

zoom - the zoom level

create

static ICanvasContext create(CanvasControl canvas,
                             double zoom,
                             double hitTestRadius)

Provides a default immutable ICanvasContext with the given values.

If the values for zoom or hitTestRadius are not specified, the values will be obtained from the given canvas.

Parameters:

canvas - the canvas

zoom - the zoom level

hitTestRadius - the hit test radius

getCanvasControl

CanvasControl getCanvasControl()

Yields the Canvas that is associated with this context.

This value may be null in those cases where no control can be associated with the current context.

Returns:

The CanvasControl.

getHitTestRadius

double getHitTestRadius()

The radius for hit tests and marquee selection tests in world coordinates.

This value already takes the zoom level into account.

Returns:

The HitTestRadius.

getZoom

double getZoom()

Returns the current zoom level that is the ratio of world coordinates to screen pixels.

Returns:

The Zoom.