org.eclipse.eavp.viz.service.paraview.widgets

Class ParaViewMouseAdapter

java.lang.Object

org.eclipse.eavp.viz.service.paraview.widgets.ParaViewMouseAdapter

public class ParaViewMouseAdapter
extends java.lang.Object

This class manages mouse controls for an ParaViewCanvas and feeds events to an associated Canvas at the appropriate intervals.

Author:

Jordan Deyton, Robert Smith

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParaViewMouseAdapter.MouseInteractionType A simple enumeration representing the allowed action strings.

Constructor Summary

Constructors

Constructor and Description
ParaViewMouseAdapter() The default constructor.
ParaViewMouseAdapter(IParaViewWebClient client, int viewId, org.eclipse.swt.widgets.Control control) The full constructor.

Method Summary

Modifier and Type	Method and Description
boolean	setCanvas(ParaViewCanvas canvas) Sets the ParaViewCanvas that will be refreshed after a mouse event in the control is processed and posted to the web client.
boolean	setClient(IParaViewWebClient client) Sets the current ParaView web client used by this mouse adapter.
boolean	setControl(org.eclipse.swt.widgets.Control control) Sets the current control with which this mouse adapter is linked.
boolean	setViewId(int viewId) Sets the ID of the current view that is rendered via the associated ParaView web client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParaViewMouseAdapter

public ParaViewMouseAdapter()

The default constructor. The adapter will need to have its ParaView web client, view, and associated Control set.

ParaViewMouseAdapter

public ParaViewMouseAdapter(IParaViewWebClient client,
                            int viewId,
                            org.eclipse.swt.widgets.Control control)

The full constructor.

Parameters:

client - The client that is providing a ParaView image. Mouse events will trigger updates to this client.

viewId - The current view ID on the client. It will be updated by mouse events.

control - The current SWT Control to which this adapter is registered for its various listener operations. Although this is typically a ParaViewCanvas, it may be any SWT Control.

Method Detail

setCanvas

public boolean setCanvas(ParaViewCanvas canvas)

Sets the ParaViewCanvas that will be refreshed after a mouse event in the control is processed and posted to the web client.

Parameters:

canvas - The target Canvas that will be updated. If null, no Canvas will be updated after mouse events.

Returns:

True if the Canvas was changed to a new value.

setClient

public boolean setClient(IParaViewWebClient client)

Sets the current ParaView web client used by this mouse adapter.

Note: Any change is not guaranteed to take effect until the next mouse event on the associated control.

Parameters:

client - The new client. If null or not connected, then the rendered image will not be able to update.

Returns:

True if the client was changed to a new value, false otherwise.

setControl

public boolean setControl(org.eclipse.swt.widgets.Control control)

Sets the current control with which this mouse adapter is linked. After this call, this adapter will no longer be registered with the previous control but will be registered with the new control.

Parameters:

control - The new SWT Control on which this adapter should listen for mouse events.

Returns:

True if the control was changed to a new value, false otherwise.

setViewId

public boolean setViewId(int viewId)

Sets the ID of the current view that is rendered via the associated ParaView web client.

Note: Any change is not guaranteed to take effect until the next mouse event on the associated control.

Parameters:

viewId - The ID of the view to be rendered. If invalid, then the rendered image will not be able to update.

Returns:

True if the view ID was changed to a new value, false otherwise.