CommandFinderBase (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Window
    - - java.awt.Frame
      - javax.swing.JFrame
        
        fiji.util.gui.CommandFinderBase

All Implemented Interfaces:

ActionListener, ItemListener, KeyListener, MouseListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

JFrameCommandFinder
```
public abstract class CommandFinderBase
extends JFrame
implements ActionListener, WindowListener, KeyListener, ItemListener, MouseListener
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`CommandFinderBase.Action`
`protected static class`	`CommandFinderBase.LevenshteinPair`
`protected class`	`CommandFinderBase.PromptDocumentListener`

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
`protected List<CommandFinderBase.Action>`	`actions`
`protected JButton`	`closeButton`
`protected JCheckBox`	`closeCheckBox`
`protected JList`	`completions`
`protected DefaultListModel`	`completionsModel`
`protected JButton`	`exportButton`
`protected JCheckBox`	`fullInfoCheckBox`
`protected JCheckBox`	`fuzzyCheckBox`
`protected JTextField`	`prompt`
`protected JButton`	`runButton`
`protected JScrollPane`	`scrollPane`

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

CommandFinderBase(String title)

Constructors
Constructor and Description
`CommandFinderBase(String title)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent ae)`
`protected boolean`	`closeWhenRunning()`
`void`	`dispose()`
`void`	`error(String message)` Override this function to have your own error box that does not focus on the ImageJ window.
`protected boolean`	`fuzzyMatching()`
`void`	`itemStateChanged(ItemEvent ie)`
`void`	`keyPressed(KeyEvent ke)`
`void`	`keyReleased(KeyEvent ke)`
`void`	`keyTyped(KeyEvent ke)`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`abstract void`	`populateActions()` This function is required to populate the list of actions
`protected void`	`populateList(String matchingSubstring)`
`protected void`	`populateListFuzzily(String substring, boolean fullInfo)`
`void`	`run(CommandFinderBase.Action action)`
`void`	`run(int itemIndex)`
`void`	`runSelected()`
`void`	`setVisible(boolean visible)`
`protected boolean`	`showFullInformation()`
`void`	`windowActivated(WindowEvent e)`
`void`	`windowClosed(WindowEvent e)`
`void`	`windowClosing(WindowEvent e)`
`void`	`windowDeactivated(WindowEvent e)`
`void`	`windowDeiconified(WindowEvent e)`
`void`	`windowIconified(WindowEvent e)`
`void`	`windowOpened(WindowEvent e)`

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, 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, pack, 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, 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, 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

prompt
```
protected JTextField prompt
```

completions
```
protected JList completions
```

scrollPane
```
protected JScrollPane scrollPane
```

completionsModel

protected DefaultListModel completionsModel

runButton
```
protected JButton runButton
```

closeButton
```
protected JButton closeButton
```

exportButton
```
protected JButton exportButton
```

fullInfoCheckBox
```
protected JCheckBox fullInfoCheckBox
```

fuzzyCheckBox
```
protected JCheckBox fuzzyCheckBox
```

closeCheckBox
```
protected JCheckBox closeCheckBox
```

actions

protected List<CommandFinderBase.Action> actions

Constructor Detail

CommandFinderBase

public CommandFinderBase(String title)

Method Detail
- populateActions
```
public abstract void populateActions()
```
  This function is required to populate the list of actions
- error
```
public void error(String message)
```
  Override this function to have your own error box that does not focus on the ImageJ window.
- showFullInformation
```
protected boolean showFullInformation()
```
- fuzzyMatching
```
protected boolean fuzzyMatching()
```
- closeWhenRunning
```
protected boolean closeWhenRunning()
```
- populateList
```
protected void populateList(String matchingSubstring)
```
- populateListFuzzily
```
protected void populateListFuzzily(String substring,
                                   boolean fullInfo)
```
- run
```
public void run(CommandFinderBase.Action action)
```
- run
```
public void run(int itemIndex)
```
- runSelected
```
public void runSelected()
```
- setVisible
```
public void setVisible(boolean visible)
```
  Overrides:
  
  setVisible in class Window
- dispose
```
public void dispose()
```
  Overrides:
  
  dispose in class Window
- actionPerformed
```
public void actionPerformed(ActionEvent ae)
```
  Specified by:
  
  actionPerformed in interface ActionListener
- itemStateChanged
```
public void itemStateChanged(ItemEvent ie)
```
  Specified by:
  
  itemStateChanged in interface ItemListener
- mouseClicked
```
public void mouseClicked(MouseEvent e)
```
  Specified by:
  
  mouseClicked in interface MouseListener
- mousePressed
```
public void mousePressed(MouseEvent e)
```
  Specified by:
  
  mousePressed in interface MouseListener
- mouseReleased
```
public void mouseReleased(MouseEvent e)
```
  Specified by:
  
  mouseReleased 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
- keyPressed
```
public void keyPressed(KeyEvent ke)
```
  Specified by:
  
  keyPressed in interface KeyListener
- keyReleased
```
public void keyReleased(KeyEvent ke)
```
  Specified by:
  
  keyReleased in interface KeyListener
- keyTyped
```
public void keyTyped(KeyEvent ke)
```
  Specified by:
  
  keyTyped in interface KeyListener
- windowClosing
```
public void windowClosing(WindowEvent e)
```
  Specified by:
  
  windowClosing in interface WindowListener
- windowActivated
```
public void windowActivated(WindowEvent e)
```
  Specified by:
  
  windowActivated in interface WindowListener
- windowDeactivated
```
public void windowDeactivated(WindowEvent e)
```
  Specified by:
  
  windowDeactivated in interface WindowListener
- windowClosed
```
public void windowClosed(WindowEvent e)
```
  Specified by:
  
  windowClosed in interface WindowListener
- windowOpened
```
public void windowOpened(WindowEvent e)
```
  Specified by:
  
  windowOpened in interface WindowListener
- windowIconified
```
public void windowIconified(WindowEvent e)
```
  Specified by:
  
  windowIconified in interface WindowListener
- windowDeiconified
```
public void windowDeiconified(WindowEvent e)
```
  Specified by:
  
  windowDeiconified in interface WindowListener

Class CommandFinderBase

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

prompt

completions

scrollPane

completionsModel

runButton

closeButton

exportButton

fullInfoCheckBox

fuzzyCheckBox

closeCheckBox

actions

Constructor Detail

CommandFinderBase

Method Detail

populateActions

error

showFullInformation

fuzzyMatching

closeWhenRunning

populateList

populateListFuzzily

run

run

runSelected

setVisible

dispose

actionPerformed

itemStateChanged

mouseClicked

mousePressed

mouseReleased

mouseEntered

mouseExited

keyPressed

keyReleased

keyTyped

windowClosing

windowActivated

windowDeactivated

windowClosed

windowOpened

windowIconified

windowDeiconified