org.das2.event

Interface DragRenderer

All Known Implementing Classes:

AbstractDragRenderer, ArrowDragRenderer, BoxGesturesRenderer, BoxRenderer, BoxZoomGesturesRenderer, CrossHairRenderer, EmptyDragRenderer, FrequencyDragRenderer, GesturesRenderer, HorizontalDragRangeRenderer, HorizontalFrequencyDragRenderer, HorizontalRangeGesturesRenderer, HorizontalRangeRenderer, HorizontalSliceSelectionRenderer, LabelDragRenderer, LengthDragRenderer, MoveComponentMouseModule.MoveRenderer, PointSlopeDragRenderer, VerticalDragRangeRenderer, VerticalRangeGesturesRenderer, VerticalSliceSelectionRenderer, WaypointsDragRenderer

public interface DragRenderer

A DragRenderer provides the feedback to the human operator of what their mousing is doing. It applies constraints to the drag as well. It promotes the AWT mouse events into events that represent the operation, implementing for example mouse gestures.

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	ghostColor use this color when drawing ghostly backgrounds for contrast.

Method Summary

Modifier and Type	Method and Description
void	clear(java.awt.Graphics g) clears whatever renderDrag rendered.
MouseDragEvent	getMouseDragEvent(java.lang.Object source, java.awt.Point p1, java.awt.Point p2, boolean isModified) promotes the drag begin and end into a mouseDragEvent.
boolean	isPointSelection() indicates that the mouse module's mousePointSelected() should be called as new mouse events come in.
boolean	isUpdatingDragSelection() range selection events should be fired during drag.
java.awt.Rectangle[]	renderDrag(java.awt.Graphics g, java.awt.Point p1, java.awt.Point p2) draws the drag for mousing from p1 to p2, and returns an array of Rectangles covering the rendering.

Field Detail

ghostColor

static final java.awt.Color ghostColor

use this color when drawing ghostly backgrounds for contrast.

Method Detail

renderDrag

java.awt.Rectangle[] renderDrag(java.awt.Graphics g,
                                java.awt.Point p1,
                                java.awt.Point p2)

draws the drag for mousing from p1 to p2, and returns an array of Rectangles covering the rendering. If nothing is drawn, then an array of length zero should be returned, and nulls are allowed in the array. p1 and p2, and g are in the canvas frame of reference.

Parameters:

g - the graphics context for rendering

p1 - the click point

p2 - the current mouse position during drag and release.

Returns:

clear

void clear(java.awt.Graphics g)

clears whatever renderDrag rendered. This is not used by the DasMouseInputAdapter, but must still be supported for now. Originally the drag renderer would have to unpaint itself as well, but this is no longer used.

Parameters:

g - the graphics context

getMouseDragEvent

MouseDragEvent getMouseDragEvent(java.lang.Object source,
                                 java.awt.Point p1,
                                 java.awt.Point p2,
                                 boolean isModified)

promotes the drag begin and end into a mouseDragEvent.

Parameters:

source -

p1 - the click point

p2 - the current mouse position during drag and release.

isModified -

Returns:

isPointSelection

boolean isPointSelection()

indicates that the mouse module's mousePointSelected() should be called as new mouse events come in.

Returns:

true if the mouse module should receive events during the drag.

isUpdatingDragSelection

boolean isUpdatingDragSelection()

range selection events should be fired during drag.

Returns:

true if selection events should be fired during drag.