com.yworks.yfiles.view.input

Class OverviewInputMode

java.lang.Object

com.yworks.yfiles.view.input.MultiplexingInputMode

com.yworks.yfiles.view.input.OverviewInputMode

All Implemented Interfaces:

IInputMode

public class OverviewInputMode
extends MultiplexingInputMode

An IInputMode that can be used for an overview CanvasControl.

This mode will add navigation capabilities to the control it is installed in.

See Also:

getClientCanvas(), getHandleInputMode(), getMoveInputMode(), getKeyboardInputMode(), getClickInputMode(), getTapInputMode()

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceKey	VIEWPORT_TEMPLATE_KEY A ResourceKey that should yield a IVisualTemplate that will be used by this mode render the viewport.

Constructor Summary

Constructors

Constructor and Description
OverviewInputMode() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected ClickInputMode	createClickInputMode() Factory method for the ClickInputMode property.
protected HandleInputMode	createHandleInputMode() Factory method for the HandleInputMode property.
protected KeyboardInputMode	createKeyboardInputMode() Factory method for the KeyboardInputMode property.
protected MoveInputMode	createMoveInputMode() Factory method for the MoveInputMode property.
protected TapInputMode	createTapInputMode() Factory method for the TapInputMode property.
Collection<ICommand>	getAvailableCommands() Gets the list of commands that are available in this instance.
ClickInputMode	getClickInputMode() Gets the ClickInputMode.
CanvasControl	getClientCanvas() Gets the canvas this canvas should use to navigate.
HandleInputMode	getHandleInputMode() Gets the HandleInputMode.
KeyboardInputMode	getKeyboardInputMode() Gets the KeyboardInputMode.
InsetsD	getMargins() Gets the insets in view coordinates that should be used by the updateVisibleArea() operation.
MoveInputMode	getMoveInputMode() Gets the MoveInputMode.
TapInputMode	getTapInputMode() Gets the TapInputMode.
IVisualTemplate	getTemplate() Gets the template that is used for the visualization of the marquee rectangle.
protected void	initialize() Performs one-time initialization of this instance.
void	install(IInputModeContext context, ConcurrencyController controller) Installs this mode into the given context that is provided by the canvas.
boolean	isAutoMouseWheelZoomEnabled() Determines whether the mouse wheel can be used to perform zooming in the ClientCanvas.
boolean	isAutoUpdateEnabled() Determines whether the the canvas this mode is installed in should automatically be invalidated if the client canvas gets invalidated.
void	setAutoMouseWheelZoomEnabled(boolean value) Determines whether the mouse wheel can be used to perform zooming in the ClientCanvas.
void	setAutoUpdateEnabled(boolean value) Determines whether the the canvas this mode is installed in should automatically be invalidated if the client canvas gets invalidated.
void	setClientCanvas(CanvasControl value) Sets the canvas this canvas should use to navigate.
void	setMargins(InsetsD value) Sets the insets in view coordinates that should be used by the updateVisibleArea() operation.
void	setTemplate(IVisualTemplate value) Sets the template that is used for the visualization of the marquee rectangle.
protected boolean	shouldInstallCommand(ICommand command) Callback method that is used by createKeyboardInputMode() to determine which of the built-in ICommands to install.
void	uninstall(IInputModeContext context) Uninstalls this mode from the given context.
protected void	updateVisibleArea() Updates the zoom and viewpoint of the overview control.

Methods inherited from class com.yworks.yfiles.view.input.MultiplexingInputMode

add, adjustCursor, cancel, childInputModeContextLookup, createChildInputModeContext, createInputModeEventArgs, getController, getDefaultCursor, getInputModeContext, getMutexOwner, getPriority, getSortedModes, invalidate, isEnabled, isExclusive, onConcurrencyControllerActivated, onConcurrencyControllerDeactivated, remove, setDefaultCursor, setEnabled, setExclusive, setPriority, stop, subModePriorityChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VIEWPORT_TEMPLATE_KEY

public static final ResourceKey VIEWPORT_TEMPLATE_KEY

A ResourceKey that should yield a IVisualTemplate that will be used by this mode render the viewport.

When explicitly setting a Template, this key will not be used. This is only a fallback if Template is null.

Constructor Detail

OverviewInputMode

public OverviewInputMode()

Creates a new instance.

Method Detail

createClickInputMode

protected ClickInputMode createClickInputMode()

Factory method for the ClickInputMode property.

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

Returns:

a new instance of ClickInputMode

createHandleInputMode

protected HandleInputMode createHandleInputMode()

Factory method for the HandleInputMode property.

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

Returns:

a new instance of HandleInputMode

createKeyboardInputMode

protected KeyboardInputMode createKeyboardInputMode()

Factory method for the KeyboardInputMode property.

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

Returns:

a new instance of KeyboardInputMode

createMoveInputMode

protected MoveInputMode createMoveInputMode()

Factory method for the MoveInputMode property.

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

Returns:

a new instance of MoveInputMode

createTapInputMode

protected TapInputMode createTapInputMode()

Factory method for the TapInputMode property.

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

Returns:

a new instance of TapInputMode

getAvailableCommands

public final Collection<ICommand> getAvailableCommands()

Gets the list of commands that are available in this instance.

Removing commands from this collection also removes the command bindings registered by this instance.

Add supported commands to make them available in this instance.

Supported commands are

• ICommand.MOVE_LEFT
• ICommand.MOVE_RIGHT
• ICommand.MOVE_UP
• ICommand.MOVE_DOWN
• ICommand.ZOOM
• ICommand.INCREASE_ZOOM
• ICommand.DECREASE_ZOOM
• ICommand.SCROLL_PAGE_DOWN
• ICommand.SCROLL_PAGE_UP
• ICommand.SCROLL_PAGE_LEFT
• ICommand.SCROLL_PAGE_RIGHT
• ICommand.FIT_CONTENT
• ICommand.UPDATE_CONTENT_RECT

Returns:

The AvailableCommands.

getClickInputMode

public final ClickInputMode getClickInputMode()

Gets the ClickInputMode.

If the field has not yet been initialized upon first access, the factory method createClickInputMode() will be called.

By default this input mode has a priority of 0.

Returns:

The ClickInputMode.

getClientCanvas

public final CanvasControl getClientCanvas()

Gets the canvas this canvas should use to navigate.

Returns:

The ClientCanvas.

See Also:

setClientCanvas(CanvasControl)

getHandleInputMode

public final HandleInputMode getHandleInputMode()

Gets the HandleInputMode.

This mode is responsible for handling the single handle that allows to resize the viewport rectangle.

If the field has not yet been initialized upon first access, the factory method createHandleInputMode() will be called.

By default this input mode has a priority of 10.

Returns:

The HandleInputMode.

getKeyboardInputMode

public final KeyboardInputMode getKeyboardInputMode()

Gets the KeyboardInputMode.

This mode handles all keyboard interaction gestures with the overview control.

If the field has not yet been initialized upon first access, the factory method createKeyboardInputMode() will be called.

By default this input mode has a priority of 0.

Returns:

The KeyboardInputMode.

getMargins

public final InsetsD getMargins()

Gets the insets in view coordinates that should be used by the updateVisibleArea() operation.

This influences the amount of visible whitespace in the view coordinate system around the graph after the content rect of the ClientCanvas has changed. The default value is (5,5,5,5).

Returns:

The Margins.

See Also:

setMargins(InsetsD)

getMoveInputMode

public final MoveInputMode getMoveInputMode()

Gets the MoveInputMode.

This mode is responsible for moving the viewport rectangle.

If the field has not yet been initialized upon first access, the factory method createMoveInputMode() will be called.

By default this input mode has a priority of 20.

Returns:

The MoveInputMode.

getTapInputMode

public final TapInputMode getTapInputMode()

Gets the TapInputMode.

If the field has not yet been initialized upon first access, the factory method createTapInputMode() will be called.

By default this input mode has a priority of 30.

Returns:

The TapInputMode.

getTemplate

public final IVisualTemplate getTemplate()

Gets the template that is used for the visualization of the marquee rectangle.

Returns:

The template.

See Also:

setTemplate(IVisualTemplate)

initialize

protected void initialize()

Description copied from class: MultiplexingInputMode

Performs one-time initialization of this instance.

This method should not be invoked by subclasses. This will be done automatically upon first installation of this mode.

This code will be executed only once per instance. The Canvas property and InputModeContext property will be null when this code is executed. This method should not be used to install this mode into a specific canvas. Subclasses should always call base.Initialize() first.

Overrides:

initialize in class MultiplexingInputMode

See Also:

MultiplexingInputMode.install(IInputModeContext, ConcurrencyController)

install

public void install(IInputModeContext context,
                    ConcurrencyController controller)

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

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.

Specified by:

install in interface IInputMode

Overrides:

install in class MultiplexingInputMode

Parameters:

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

controller - The ConcurrencyController for this mode.

See Also:

IInputMode.uninstall(IInputModeContext)

isAutoMouseWheelZoomEnabled

public final boolean isAutoMouseWheelZoomEnabled()

Determines whether the mouse wheel can be used to perform zooming in the ClientCanvas.

The default value is true.

Returns:

The AutoMouseWheelZoomEnabled.

See Also:

setAutoMouseWheelZoomEnabled(boolean)

isAutoUpdateEnabled

public final boolean isAutoUpdateEnabled()

Determines whether the the canvas this mode is installed in should automatically be invalidated if the client canvas gets invalidated.

Automatic invalidation will be deferred to avoid too frequent updates of the overview.

To manually update the overview when this property is false, call the CanvasControl.invalidate() method on the GraphOverviewControl.

Returns:

The AutoUpdateEnabled.

See Also:

setAutoUpdateEnabled(boolean)

setAutoMouseWheelZoomEnabled

public final void setAutoMouseWheelZoomEnabled(boolean value)

Determines whether the mouse wheel can be used to perform zooming in the ClientCanvas.

The default value is true.

Parameters:

value - The AutoMouseWheelZoomEnabled to set.

See Also:

isAutoMouseWheelZoomEnabled()

setAutoUpdateEnabled

public final void setAutoUpdateEnabled(boolean value)

Determines whether the the canvas this mode is installed in should automatically be invalidated if the client canvas gets invalidated.

Automatic invalidation will be deferred to avoid too frequent updates of the overview.

To manually update the overview when this property is false, call the CanvasControl.invalidate() method on the GraphOverviewControl.

Parameters:

value - The AutoUpdateEnabled to set.

See Also:

isAutoUpdateEnabled()

setClientCanvas

public final void setClientCanvas(CanvasControl value)

Sets the canvas this canvas should use to navigate.

Parameters:

value - The ClientCanvas to set.

See Also:

getClientCanvas()

setMargins

public final void setMargins(InsetsD value)

Sets the insets in view coordinates that should be used by the updateVisibleArea() operation.

This influences the amount of visible whitespace in the view coordinate system around the graph after the content rect of the ClientCanvas has changed. The default value is (5,5,5,5).

Parameters:

value - The Margins to set.

See Also:

getMargins()

setTemplate

public final void setTemplate(IVisualTemplate value)

Sets the template that is used for the visualization of the marquee rectangle.

Parameters:

value - The template.

See Also:

getTemplate()

shouldInstallCommand

protected boolean shouldInstallCommand(ICommand command)

Callback method that is used by createKeyboardInputMode() to determine which of the built-in ICommands to install.

This implementation unconditionally returns true, subclasses may override this method to adjust the behavior.

Parameters:

command - The command to install.

Returns:

Whether to install this command.

uninstall

public void uninstall(IInputModeContext context)

Uninstalls this mode from the given context.

This code should clean up all changes made to the canvas in the IInputMode.install(IInputModeContext, ConcurrencyController) 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.

Specified by:

uninstall in interface IInputMode

Overrides:

uninstall in class MultiplexingInputMode

Parameters:

context - The context to deregister from. This is the same instance that had been passed to IInputMode.install(IInputModeContext, ConcurrencyController) during installation.

updateVisibleArea

protected void updateVisibleArea()

Updates the zoom and viewpoint of the overview control.

This method is called when the graph bounds of the getClientCanvas() have changed. The margins should be respected.