OpFinder (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Window
    - - java.awt.Frame
      - javax.swing.JFrame
        
        net.imagej.ui.swing.ops.OpFinder

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, RootPaneContainer, WindowConstants
```
public class OpFinder
extends JFrame
implements DocumentListener, ActionListener
```
A searchable tree-table view of all discovered Op implementations. The goal of this tool is to make it easy to explore the available Ops , their associated Namespace, and specific signatures available for these ops. This caters to the extensibility of Ops, allowing us to discover all Op Plugins at runtime instead of trying to provide static documentation about available functions.
Without filtering, Ops are displayed tree-style where Namespaces and Op types create a collapsible hierarchy. Concrete Op signatures are the leaves. These Op signatures can be executed individually or copied and pasted into the a script.

A filter bar allows users to narrow the displayed ops based on a fuzzy scoring algorithm. When filtering, namespaces are hidden.

The UI itself can be toggled into a "user" or "developer" view, with differing levels of granularity both in the Ops displayed and the amount of information provided about an individual Op. Rounding out the display is a sidebar information panel which can be expanded/collapsed as desired.

Author:

Mark Hiner

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JFrame
  JFrame.AccessibleJFrame
- Nested classes/interfaces inherited from class java.awt.Frame
  Frame.AccessibleAWTFrame
- Nested classes/interfaces inherited from class java.awt.Window
  Window.AccessibleAWTWindow, Window.Type
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASE_JAVADOC_URL`
`static int`	`COLUMN_MARGIN`
`static int`	`DETAILS_WINDOW_WIDTH`
`static int`	`HIDE_COOLDOWN`
`static String`	`IMG_REGEX`
`static String`	`IMGPLUS_REGEX`
`static int`	`MAIN_WINDOW_HEIGHT`
`static String`	`NO_NAMESPACE`
`static String`	`NUMBER_REGEX`
`static String`	`SIMPLE_KEY`
`static String`	`WINDOW_HEIGHT`
`static String`	`WINDOW_WIDTH`

Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

OpFinder(Context context)

Constructors
Constructor and Description
`OpFinder(Context context)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)`
`void`	`changedUpdate(DocumentEvent e)`
`void`	`insertUpdate(DocumentEvent e)`
`void`	`pack()`
`void`	`removeUpdate(DocumentEvent e)`
`void`	`requestFocus()`
`void`	`setState(boolean toSimple)` Set whether the `Op Finder` should be in simple or advanced mode.

Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

Methods inherited from interface java.awt.MenuContainer
getFont, postEvent

- Field Detail
  - DETAILS_WINDOW_WIDTH
```
public static final int DETAILS_WINDOW_WIDTH
```
    See Also:
    
    Constant Field Values
  - MAIN_WINDOW_HEIGHT
```
public static final int MAIN_WINDOW_HEIGHT
```
    See Also:
    
    Constant Field Values
  - COLUMN_MARGIN
```
public static final int COLUMN_MARGIN
```
    See Also:
    
    Constant Field Values
  - HIDE_COOLDOWN
```
public static final int HIDE_COOLDOWN
```
    See Also:
    
    Constant Field Values
  - WINDOW_HEIGHT
```
public static final String WINDOW_HEIGHT
```
    See Also:
    
    Constant Field Values
  - WINDOW_WIDTH
```
public static final String WINDOW_WIDTH
```
    See Also:
    
    Constant Field Values
  - NO_NAMESPACE
```
public static final String NO_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - BASE_JAVADOC_URL
```
public static final String BASE_JAVADOC_URL
```
    See Also:
    
    Constant Field Values
  - SIMPLE_KEY
```
public static final String SIMPLE_KEY
```
    See Also:
    
    Constant Field Values
  - IMG_REGEX
```
public static final String IMG_REGEX
```
    See Also:
    
    Constant Field Values
  - IMGPLUS_REGEX
```
public static final String IMGPLUS_REGEX
```
    See Also:
    
    Constant Field Values
  - NUMBER_REGEX
```
public static final String NUMBER_REGEX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OpFinder
```
public OpFinder(Context context)
```
- Method Detail
  - setState
```
public void setState(boolean toSimple)
```
    Set whether the Op Finder should be in simple or advanced mode.
    
    Parameters:
    
    toSimple - true if we should go to simple mode, false if we should go to advanced mode.
  - requestFocus
```
public void requestFocus()
```
    Overrides:
    
    requestFocus in class Component
  - pack
```
public void pack()
```
    Overrides:
    
    pack in class Window
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface ActionListener
  - insertUpdate
```
public void insertUpdate(DocumentEvent e)
```
    Specified by:
    
    insertUpdate in interface DocumentListener
  - removeUpdate
```
public void removeUpdate(DocumentEvent e)
```
    Specified by:
    
    removeUpdate in interface DocumentListener
  - changedUpdate
```
public void changedUpdate(DocumentEvent e)
```
    Specified by:
    
    changedUpdate in interface DocumentListener

Class OpFinder

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

Nested classes/interfaces inherited from class java.awt.Frame

Nested classes/interfaces inherited from class java.awt.Window

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JFrame

Fields inherited from class java.awt.Frame

Fields inherited from class java.awt.Component

Fields inherited from interface javax.swing.WindowConstants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JFrame

Methods inherited from class java.awt.Frame

Methods inherited from class java.awt.Window

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface java.awt.MenuContainer

Field Detail

DETAILS_WINDOW_WIDTH

MAIN_WINDOW_HEIGHT

COLUMN_MARGIN

HIDE_COOLDOWN

WINDOW_HEIGHT

WINDOW_WIDTH

NO_NAMESPACE

BASE_JAVADOC_URL

SIMPLE_KEY

IMG_REGEX

IMGPLUS_REGEX

NUMBER_REGEX

Constructor Detail

OpFinder

Method Detail

setState

requestFocus

pack

actionPerformed

insertUpdate

removeUpdate

changedUpdate