PathManagerUI (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Window
    - - java.awt.Dialog
      - javax.swing.JDialog
        
        sc.fiji.snt.PathManagerUI

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, TreeSelectionListener, RootPaneContainer, WindowConstants
```
public class PathManagerUI
extends JDialog
implements TreeSelectionListener
```
Implements the Path Manager Dialog.

Author:

Tiago Ferreira

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JDialog
  JDialog.AccessibleJDialog
- Nested classes/interfaces inherited from class java.awt.Dialog
  Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
- 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 GuiUtils guiUtils

protected static String TABLE_TITLE
- Fields inherited from class javax.swing.JDialog
  accessibleContext, rootPane, rootPaneCheckingEnabled
- Fields inherited from class java.awt.Dialog
  DEFAULT_MODALITY_TYPE
- 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, EXIT_ON_CLOSE, HIDE_ON_CLOSE
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields
Modifier and Type	Field and Description
`protected GuiUtils`	`guiUtils`
`protected static String`	`TABLE_TITLE`

Constructor Summary

Constructors
Constructor and Description

PathManagerUI(SNT plugin)
Instantiates a new Path Manager Dialog.

Constructors
Constructor and Description
`PathManagerUI(SNT plugin)` Instantiates a new Path Manager Dialog.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyDefaultTags(String... defaultTags)` Applies a default (built-in) tag to selected Path(s).
`void`	`applySelectionFilter(String query)` Selects paths matching a text-based criteria.
`void`	`applySelectionFilter(String property, Number criteria)` Selects paths matching a morphometric criteria.
`void`	`applySelectionFilter(String property, Number min, Number max)` Selects paths matching a morphometric criteria.
`void`	`applyTag(String customTagOrColor)` Applies a custom tag/ color to selected Path(s).
`protected void`	`cancelFit(boolean updateUIState)`
`void`	`clearSelection()`
`protected void`	`closeTable()`
`static String`	`extractTagsFromPath(Path p)`
`Tree`	`geSelectedPathsAsTree()` Gets the collection of paths listed in the Path Manager as a `Tree` object.
`JTree`	`getJTree()`
`protected Collection<Tree>`	`getMultipleTrees()`
`protected Tree`	`getMultipleTreesInASingleContainer()`
`PathAndFillManager`	`getPathAndFillManager()`
`com.jidesoft.swing.Searchable`	`getSearchable()`
`List<Path>`	`getSelectedPaths(boolean ifNoneSelectedGetAll)` Gets the paths currently selected in the Manager's `JTree` list.
`Map<String,Tree>`	`getSelectedPathsOrganizedByTrees(boolean ifNoneSelectedGetAll)` Gets the paths currently selected in the Manager's `JTree` list as `Tree`s.
`protected Tree`	`getSingleTree()`
`SNT`	`getSNT()`
`protected SNTTable`	`getTable()`
`static void`	`main(String[] args)`
`protected boolean`	`measurementsUnsaved()`
`protected void`	`quickMeasurementsCmdError(GuiUtils guiUtils)`
`void`	`reload()` Reloads the contents of `PathAndFillManager`
`void`	`runCommand(String cmd)` Runs a menu command.
`void`	`runCommand(String cmd, String... args)` Runs a menu command with options.
`protected void`	`saveTable()`
`void`	`selectAll()`
`protected boolean`	`selectionExists()`
`void`	`setFillList(List<Fill> fillList)`
`void`	`setPathList(List<Path> pathList, Path justAdded, boolean expandAll)`
`void`	`setSelectedPaths(Collection<Path> selectedPaths, Object source)`
`void`	`update()` Refreshes (Repaints) the Path Manager JTree.
`protected void`	`updateTable()`
`void`	`valueChanged(TreeSelectionEvent e)`

Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

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, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, remove, 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

- Field Detail
  - TABLE_TITLE
```
protected static final String TABLE_TITLE
```
    See Also:
    
    Constant Field Values
  - guiUtils
```
protected final GuiUtils guiUtils
```
- Constructor Detail
  - PathManagerUI
```
public PathManagerUI(SNT plugin)
```
    Instantiates a new Path Manager Dialog.
    
    Parameters:
    
    plugin - the the SNT instance to be associated with this Path Manager. It is assumed that its SNTUI is available.
- Method Detail
  - getSelectedPathsOrganizedByTrees
```
public Map<String,Tree> getSelectedPathsOrganizedByTrees(boolean ifNoneSelectedGetAll)
```
    Gets the paths currently selected in the Manager's JTree list as Trees.
    
    Parameters:
    
    ifNoneSelectedGetAll - if true and no paths are currently selected, all Paths in the list are considered
    
    Returns:
    
    the map of selected paths (as keys
    
    See Also:
    
    getSelectedPaths(boolean)
  - getSelectedPaths
```
public List<Path> getSelectedPaths(boolean ifNoneSelectedGetAll)
```
    Gets the paths currently selected in the Manager's JTree list.
    
    Parameters:
    
    ifNoneSelectedGetAll - if true and no paths are currently selected, all Paths in the list will be returned
    
    Returns:
    
    the selected paths. Note that children of a Path are not returned if unselected.
  - selectionExists
```
protected boolean selectionExists()
```
  - cancelFit
```
protected void cancelFit(boolean updateUIState)
```
  - valueChanged
```
public void valueChanged(TreeSelectionEvent e)
```
    Specified by:
    
    valueChanged in interface TreeSelectionListener
  - setSelectedPaths
```
public void setSelectedPaths(Collection<Path> selectedPaths,
                             Object source)
```
  - setPathList
```
public void setPathList(List<Path> pathList,
                        Path justAdded,
                        boolean expandAll)
```
  - getSingleTree
```
protected Tree getSingleTree()
```
  - getMultipleTrees
```
protected Collection<Tree> getMultipleTrees()
```
  - getMultipleTreesInASingleContainer
```
protected Tree getMultipleTreesInASingleContainer()
```
  - quickMeasurementsCmdError
```
protected void quickMeasurementsCmdError(GuiUtils guiUtils)
```
  - setFillList
```
public void setFillList(List<Fill> fillList)
```
  - update
```
public void update()
```
    Refreshes (Repaints) the Path Manager JTree. Gets called by SNT.isOnlySelectedPathsVisible() to reflect changes in path colors, etc.
  - reload
```
public void reload()
```
    Reloads the contents of PathAndFillManager
  - closeTable
```
protected void closeTable()
```
  - updateTable
```
protected void updateTable()
```
  - getTable
```
protected SNTTable getTable()
```
  - getSNT
```
public SNT getSNT()
```
  - getPathAndFillManager
```
public PathAndFillManager getPathAndFillManager()
```
  - getJTree
```
public JTree getJTree()
```
  - getSearchable
```
public com.jidesoft.swing.Searchable getSearchable()
```
  - applySelectionFilter
```
public void applySelectionFilter(String property,
                                 Number min,
                                 Number max)
                          throws IllegalArgumentException
```
    Selects paths matching a morphometric criteria.
    
    Parameters:
    
    property - The morphometric property ("Length", "Path order", etc.) as listed in the "Morphology filter" menu (case sensitive).
    
    min - the lowest value (exclusive) in the filter
    
    max - the highest value (exclusive) in the filter
    
    Throws:
    
    IllegalArgumentException - if property was not recognized. Note that some filtering options listed in the GUI may not be supported.
  - applyTag
```
public void applyTag(String customTagOrColor)
              throws IllegalArgumentException
```
    Applies a custom tag/ color to selected Path(s).
    
    Parameters:
    
    customTagOrColor - The tag (or color) to be applied to selected Paths.
    
    Throws:
    
    IllegalArgumentException
  - applyDefaultTags
```
public void applyDefaultTags(String... defaultTags)
                      throws IllegalArgumentException
```
    Applies a default (built-in) tag to selected Path(s).
    
    Parameters:
    
    defaultTags - The tags to be applied to selected Paths, as listed in the "Tag" menu, e.g, , , , etc.
    
    Throws:
    
    IllegalArgumentException
  - applySelectionFilter
```
public void applySelectionFilter(String query)
                          throws IllegalArgumentException
```
    Selects paths matching a text-based criteria.
    
    Parameters:
    
    query - The matching text, as it would have been typed in the "Text filtering" box.
    
    Throws:
    
    IllegalArgumentException
  - applySelectionFilter
```
public void applySelectionFilter(String property,
                                 Number criteria)
                          throws IllegalArgumentException
```
    Selects paths matching a morphometric criteria.
    
    Parameters:
    
    property - The morphometric property ("Length", "Path order", etc.) as listed in the "Morphology filter" menu (case sensitive).
    
    criteria - the filtering criteria.
    
    Throws:
    
    IllegalArgumentException - if property was not recognized. Note that some filtering options listed in the GUI may not be supported.
  - geSelectedPathsAsTree
```
public Tree geSelectedPathsAsTree()
```
    Gets the collection of paths listed in the Path Manager as a Tree object. All paths are retrieved if none are currently selected.
    
    Returns:
    
    the Tree holding the Path collection
  - clearSelection
```
public void clearSelection()
```
  - selectAll
```
public void selectAll()
```
  - runCommand
```
public void runCommand(String cmd)
                throws IllegalArgumentException
```
    Runs a menu command.
    
    Parameters:
    
    cmd - The command to be run, exactly as listed in the PathManagerUI's menu bar or Right-click contextual menu
    
    Throws:
    
    IllegalArgumentException - if cmd was not found.
  - runCommand
```
public void runCommand(String cmd,
                       String... args)
                throws IllegalArgumentException,
                       IOException
```
    Runs a menu command with options.
    
    Parameters:
    
    cmd - The command to be run, exactly as listed in the PathManagerUI's menu bar or Right-click contextual menu
    
    args - the option(s) that would fill the commands's prompt. e.g., 'runCommand("Color Code Cell(s)...", X coordinates", "Cyan Hot.lut")'
    
    Throws:
    
    IllegalArgumentException - if cmd was not found, or if it is not supported.
    
    IOException
  - measurementsUnsaved
```
protected boolean measurementsUnsaved()
```
  - saveTable
```
protected void saveTable()
```
  - extractTagsFromPath
```
public static String extractTagsFromPath(Path p)
```
  - main
```
public static void main(String[] args)
```

Class PathManagerUI

Nested Class Summary

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

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

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.JDialog

Fields inherited from class java.awt.Dialog

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.JDialog

Methods inherited from class java.awt.Dialog

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

Field Detail

TABLE_TITLE

guiUtils

Constructor Detail

PathManagerUI

Method Detail

getSelectedPathsOrganizedByTrees

getSelectedPaths

selectionExists

cancelFit

valueChanged

setSelectedPaths

setPathList

getSingleTree

getMultipleTrees

getMultipleTreesInASingleContainer

quickMeasurementsCmdError

setFillList

update

reload

closeTable

updateTable

getTable

getSNT

getPathAndFillManager

getJTree

getSearchable

applySelectionFilter

applyTag

applyDefaultTags

applySelectionFilter

applySelectionFilter

geSelectedPathsAsTree

clearSelection

selectAll

runCommand

runCommand

measurementsUnsaved

saveTable

extractTagsFromPath

main