RoiPicker (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.tool.AbstractTool
- - tools.RoiPicker

All Implemented Interfaces:

ToolWithOptions, ij.ImageListener, ij.plugin.PlugIn, ActionListener, MouseListener, MouseMotionListener, MouseWheelListener, WindowFocusListener, EventListener
```
public class RoiPicker
extends AbstractTool
implements ActionListener, MouseListener, MouseMotionListener, MouseWheelListener, ToolWithOptions
```
This tool is used to select the Rois containing a specific x, y position (obtained by a mouse click). Any Rois in the current RoiManager containing that point will be added to this tool's list. The Rois of the list can be itereated by repeated clicking.
NB: Known limitations to this tool:
- When displaying a union of all matching Rois, only the first will be selected in the RoiManager.
- When a Roi is selected in the RoiManager, the list itself will not automatically update to display that Roi.
- Works best with "Show all" Rois off.
Version:

1.0 - 30 Aug 2013

Author:

Mark Hinier

Nested Class Summary
- Nested classes/interfaces inherited from class fiji.tool.AbstractTool
  AbstractTool.KeyProxy, AbstractTool.KeyProxyIfNotConsumed, AbstractTool.MouseMotionProxy, AbstractTool.MouseMotionProxyIfNotConsumed, AbstractTool.MouseProxy, AbstractTool.MouseWheelProxy, AbstractTool.MouseWheelProxyIfNotConsumed, AbstractTool.ToolbarMouseAdapter

Field Summary
- Fields inherited from class fiji.tool.AbstractTool
  clearToolsIfNecessary, ijKeyProxy, keyProxy, mouseMotionProxy, mouseProxy, mouseWheelProxy, savedToolName, sliceListener, sliceObservers, toolActive, toolbar, toolbarMouseListener, toolID, toolToggleListener

Constructor Summary

Constructors
Constructor and Description

RoiPicker()

Constructors
Constructor and Description
`RoiPicker()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)`
`String`	`getToolIcon()` Return the string encoding of the tool icon as it will appear in the toolbar.
`String`	`getToolName()` Return the tool name.
`protected void`	`handleRecording()`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseDragged(MouseEvent arg0)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mouseMoved(MouseEvent e)`
`void`	`mousePressed(MouseEvent arg0)`
`void`	`mouseReleased(MouseEvent e)` Functional method of the RoiPicker.
`void`	`mouseWheelMoved(MouseWheelEvent e)`
`void`	`run(String arg)`
`static void`	`select(String style, String x1, String y1, String x2, String y2, String width, String headLength)`
`void`	`showOptionDialog()` When called, this method displays the configuration panel for the concrete implementation of this tool.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RoiPicker
```
public RoiPicker()
```
- Method Detail
  - run
```
public void run(String arg)
```
    Specified by:
    
    run in interface ij.plugin.PlugIn
    
    Overrides:
    
    run in class AbstractTool
  - getToolName
```
public String getToolName()
```
    Description copied from class: AbstractTool
    
    Return the tool name.
    
    Overrides:
    
    getToolName in class AbstractTool
  - getToolIcon
```
public String getToolIcon()
```
    Description copied from class: AbstractTool
    
    Return the string encoding of the tool icon as it will appear in the toolbar. See syntax for icon string.
    
    Overrides:
    
    getToolIcon in class AbstractTool
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
    Functional method of the RoiPicker. Determines which Rois match the x,y coordinates of the received MouseEvent and the C,Z,T coordinates of the active image. The user can cycle through these Rois with repeated clicks.
    
    Specified by:
    
    mouseReleased in interface MouseListener
  - mouseWheelMoved
```
public void mouseWheelMoved(MouseWheelEvent e)
```
    Specified by:
    
    mouseWheelMoved in interface MouseWheelListener
  - showOptionDialog
```
public void showOptionDialog()
```
    Description copied from interface: ToolWithOptions
    
    When called, this method displays the configuration panel for the concrete implementation of this tool. It is normally called when the user double-click the toolbar icon of this tool.
    
    Specified by:
    
    showOptionDialog in interface ToolWithOptions
  - mouseDragged
```
public void mouseDragged(MouseEvent arg0)
```
    Specified by:
    
    mouseDragged in interface MouseMotionListener
  - mousePressed
```
public void mousePressed(MouseEvent arg0)
```
    Specified by:
    
    mousePressed in interface MouseListener
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface MouseListener
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent e)
```
    Specified by:
    
    mouseExited in interface MouseListener
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface MouseMotionListener
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface ActionListener
  - handleRecording
```
protected void handleRecording()
```
  - select
```
public static void select(String style,
                          String x1,
                          String y1,
                          String x2,
                          String y2,
                          String width,
                          String headLength)
```

Class RoiPicker

Nested Class Summary

Nested classes/interfaces inherited from class fiji.tool.AbstractTool

Field Summary

Fields inherited from class fiji.tool.AbstractTool

Constructor Summary

Method Summary

Methods inherited from class fiji.tool.AbstractTool

Methods inherited from class java.lang.Object

Constructor Detail

RoiPicker

Method Detail

run

getToolName

getToolIcon

mouseReleased

mouseWheelMoved

showOptionDialog

mouseDragged

mousePressed

mouseClicked

mouseEntered

mouseExited

mouseMoved

actionPerformed

handleRecording

select