org.das2.event

Class LabelDragRenderer

java.lang.Object

org.das2.event.AbstractDragRenderer

org.das2.event.LabelDragRenderer

All Implemented Interfaces:

DragRenderer

Direct Known Subclasses:

CrossHairRenderer, FrequencyDragRenderer, LengthDragRenderer, PointSlopeDragRenderer

public class LabelDragRenderer
extends AbstractDragRenderer

LabelDragRenderer draws a label at the current mouse location. Typically this one overrides this class and calls the setLabel and super.renderDrag classes.

Field Summary

Fields inherited from interface org.das2.event.DragRenderer

ghostColor

Constructor Summary

Constructors

Constructor and Description
LabelDragRenderer() create an instance, and presumably the mouse module will set the parent.
LabelDragRenderer(DasCanvasComponent parent) create an instance.

Method Summary

Modifier and Type	Method and Description
protected void	addDirtyBounds(java.awt.Rectangle dirty)
protected void	addDirtyBounds(java.awt.Rectangle[] dirty)
void	clear(java.awt.Graphics g) this is not used, and is left over from an old version of the library.
protected java.awt.Rectangle[]	getDirtyBounds()
MouseDragEvent	getMouseDragEvent(java.lang.Object source, java.awt.Point p1, java.awt.Point p2, boolean isModified) This method is called by the DMIA on mouse release.
boolean	isPointSelection() indicates that MM.mousePointSelected() should called as new mouse events come in.
boolean	isTooltip()
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.
protected void	resetDirtyBounds()
void	setLabel(java.lang.String s) set the label to be drawn.
void	setTooltip(boolean tooltip)

Methods inherited from class org.das2.event.AbstractDragRenderer

getParent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelDragRenderer

public LabelDragRenderer(DasCanvasComponent parent)

create an instance.

Parameters:

parent - component sourcing the mouse events, typically a DasPlot.

LabelDragRenderer

public LabelDragRenderer()

create an instance, and presumably the mouse module will set the parent.

Method Detail

clear

public void clear(java.awt.Graphics g)

Description copied from class: AbstractDragRenderer

this is not used, and is left over from an old version of the library.

Specified by:

clear in interface DragRenderer

Overrides:

clear in class AbstractDragRenderer

Parameters:

g - the graphics context

getMouseDragEvent

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

This method is called by the DMIA on mouse release. We use this to infer the mouse release and hide the Window. Note this assumes isUpdatingDragSelection is false! TODO: DMIA should call clear so this is more explicit.

Specified by:

getMouseDragEvent in interface DragRenderer

Overrides:

getMouseDragEvent in class AbstractDragRenderer

p1 - the click point

p2 - the current mouse position during drag and release.

Returns:

the DragEvent

isPointSelection

public boolean isPointSelection()

Description copied from class: AbstractDragRenderer

indicates that MM.mousePointSelected() should called as new mouse events come in.

Specified by:

isPointSelection in interface DragRenderer

Overrides:

isPointSelection in class AbstractDragRenderer

Returns:

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

isUpdatingDragSelection

public boolean isUpdatingDragSelection()

Description copied from class: AbstractDragRenderer

range selection events should be fired during drag.

Specified by:

isUpdatingDragSelection in interface DragRenderer

Overrides:

isUpdatingDragSelection in class AbstractDragRenderer

Returns:

true if selection events should be fired during drag.

setLabel

public void setLabel(java.lang.String s)

set the label to be drawn. This should be done before this object's renderDrag is called.

Parameters:

s - the label, which can contain Granny control sequences like !A and !n.

See Also:

http://autoplot.org/help#Granny_Strings

renderDrag

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

Description copied from interface: DragRenderer

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:

resetDirtyBounds

protected void resetDirtyBounds()

addDirtyBounds

protected void addDirtyBounds(java.awt.Rectangle[] dirty)

addDirtyBounds

protected void addDirtyBounds(java.awt.Rectangle dirty)

getDirtyBounds

protected java.awt.Rectangle[] getDirtyBounds()

isTooltip

public boolean isTooltip()

setTooltip

public void setTooltip(boolean tooltip)