TrackScheme (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.visualization.AbstractTrackMateModelView
- - fiji.plugin.trackmate.visualization.trackscheme.TrackScheme

All Implemented Interfaces:

ModelChangeListener, SelectionChangeListener, TrackMateModelView, EventListener
```
public class TrackScheme
extends AbstractTrackMateModelView
```

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_COLOR

static String INFO_TEXT

static String KEY
- Fields inherited from class fiji.plugin.trackmate.visualization.AbstractTrackMateModelView
  displaySettings, model, selectionModel

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_COLOR`
`static String`	`INFO_TEXT`
`static String`	`KEY`

Constructor Summary

Constructors
Constructor and Description

TrackScheme(Model model, SelectionModel selectionModel, DisplaySettings displaySettings)

Constructors
Constructor and Description
`TrackScheme(Model model, SelectionModel selectionModel, DisplaySettings displaySettings)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addEdgeManually(com.mxgraph.model.mxCell cell)` This method is called when the user has created manually an edge in the graph, by dragging a link between two spot cells.
`void`	`captureDecorated()`
`void`	`captureUndecorated()`
`void`	`centerViewOn(Spot spot)` Centers the view on the given spot.
`void`	`clear()` Removes any overlay (for spots or tracks) from this displayer.
`void`	`doTrackLayout()`
`void`	`doTrackStyle()`
`JGraphXAdapter`	`getGraph()` Returns the `JGraphXAdapter` that serves as a model for the graph displayed in this frame.
`TrackSchemeGraphLayout`	`getGraphLayout()` Returns the graph layout in charge of arranging the cells on the graph.
`TrackSchemeFrame`	`getGUI()` Returns the GUI frame controlled by this class.
`String`	`getKey()` Returns the unique key that identifies this view.
`Model`	`getModel()` Returns the model displayed in this view.
`int`	`getNextFreeColumn(int frame)`
`SelectionModel`	`getSelectionModel()`
`int`	`getUnlaidSpotColumn()`
`void`	`linkSpots()` Create links between all the spots currently in the `Model` selection.
`void`	`modelChanged(ModelChangeEvent event)` Used to catch spot creation events that occurred elsewhere, for instance by manual editing in the `AbstractTrackMateModelView`.
`void`	`refresh()` Refreshes the displayer display with current model.
`void`	`removeSelectedCells()` Removes the cell selected by the user in the GUI.
`void`	`render()` Initializes this displayer and render it according to its concrete implementation.
`void`	`resetZoom()`
`void`	`selectionChanged(SelectionChangeEvent event)` This needs to be overridden for concrete implementation to display selection.
`void`	`selectTrack(Collection<com.mxgraph.model.mxCell> vertices, Collection<com.mxgraph.model.mxCell> edges, int direction)`
`void`	`setSpotImageUpdater(SpotImageUpdater spotImageUpdater)`
`void`	`toggleDisplayDecoration()`
`boolean`	`toggleLinking()` Toggles whether drag-&-drop linking is allowed.
`boolean`	`toggleThumbnail()` Toggles whether thumbnail capture is enabled.
`void`	`zoomIn()`
`void`	`zoomOut()`

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

- Field Detail
  - INFO_TEXT
```
public static final String INFO_TEXT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_COLOR
```
public static final String DEFAULT_COLOR
```
    See Also:
    
    Constant Field Values
  - KEY
```
public static final String KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TrackScheme
```
public TrackScheme(Model model,
                   SelectionModel selectionModel,
                   DisplaySettings displaySettings)
```
- Method Detail
  - setSpotImageUpdater
```
public void setSpotImageUpdater(SpotImageUpdater spotImageUpdater)
```
  - getSelectionModel
```
public SelectionModel getSelectionModel()
```
  - getUnlaidSpotColumn
```
public int getUnlaidSpotColumn()
```
    Returns:
    
    the column index that is the first one after all the track columns.
  - getNextFreeColumn
```
public int getNextFreeColumn(int frame)
```
    Returns:
    
    the first free column for the target row.
  - getGUI
```
public TrackSchemeFrame getGUI()
```
    Returns the GUI frame controlled by this class.
  - getGraph
```
public JGraphXAdapter getGraph()
```
    Returns the JGraphXAdapter that serves as a model for the graph displayed in this frame.
  - getGraphLayout
```
public TrackSchemeGraphLayout getGraphLayout()
```
    Returns the graph layout in charge of arranging the cells on the graph.
  - addEdgeManually
```
protected void addEdgeManually(com.mxgraph.model.mxCell cell)
```
    This method is called when the user has created manually an edge in the graph, by dragging a link between two spot cells. It checks whether the matching edge in the model exists, and tune what should be done accordingly.
    
    Parameters:
    
    cell - the mxCell of the edge that has been manually created.
  - selectionChanged
```
public void selectionChanged(SelectionChangeEvent event)
```
    Description copied from class: AbstractTrackMateModelView
    
    This needs to be overridden for concrete implementation to display selection.
    
    Specified by:
    
    selectionChanged in interface SelectionChangeListener
    
    Overrides:
    
    selectionChanged in class AbstractTrackMateModelView
    
    Parameters:
    
    event - the event that characterizes the change.
  - centerViewOn
```
public void centerViewOn(Spot spot)
```
    Description copied from interface: TrackMateModelView
    
    Centers the view on the given spot.
  - modelChanged
```
public void modelChanged(ModelChangeEvent event)
```
    Used to catch spot creation events that occurred elsewhere, for instance by manual editing in the AbstractTrackMateModelView.
    We have to deal with the graph modification ourselves here, because the Model model holds a non-listenable JGraphT instance. A modification made to the model would not be reflected on the graph here.
    
    Parameters:
    
    event - the ModelChangeEvent.
  - render
```
public void render()
```
    Description copied from interface: TrackMateModelView
    
    Initializes this displayer and render it according to its concrete implementation.
  - refresh
```
public void refresh()
```
    Description copied from interface: TrackMateModelView
    
    Refreshes the displayer display with current model. If the underlying model was modified, or the display settings were changed, calling this method should be enough to update the display with changes.
  - clear
```
public void clear()
```
    Description copied from interface: TrackMateModelView
    
    Removes any overlay (for spots or tracks) from this displayer.
  - getModel
```
public Model getModel()
```
    Description copied from interface: TrackMateModelView
    
    Returns the model displayed in this view.
    
    Specified by:
    
    getModel in interface TrackMateModelView
    
    Overrides:
    
    getModel in class AbstractTrackMateModelView
  - toggleLinking
```
public boolean toggleLinking()
```
    Toggles whether drag-&-drop linking is allowed.
    
    Returns:
    
    the current settings value, after toggling.
  - toggleThumbnail
```
public boolean toggleThumbnail()
```
    Toggles whether thumbnail capture is enabled.
    
    Returns:
    
    the current settings value, after toggling.
  - zoomIn
```
public void zoomIn()
```
  - zoomOut
```
public void zoomOut()
```
  - resetZoom
```
public void resetZoom()
```
  - doTrackStyle
```
public void doTrackStyle()
```
  - doTrackLayout
```
public void doTrackLayout()
```
  - captureUndecorated
```
public void captureUndecorated()
```
  - captureDecorated
```
public void captureDecorated()
```
  - toggleDisplayDecoration
```
public void toggleDisplayDecoration()
```
  - linkSpots
```
public void linkSpots()
```
    Create links between all the spots currently in the Model selection. We update simultaneously the Model and the JGraphXAdapter.
  - removeSelectedCells
```
public void removeSelectedCells()
```
    Removes the cell selected by the user in the GUI.
  - selectTrack
```
public void selectTrack(Collection<com.mxgraph.model.mxCell> vertices,
                        Collection<com.mxgraph.model.mxCell> edges,
                        int direction)
```
  - getKey
```
public String getKey()
```
    Description copied from interface: TrackMateModelView
    
    Returns the unique key that identifies this view.
    Careful: this key must be the same that for the ViewFactory that can instantiates this view. This is to facilitate saving/loading.
    
    Returns:
    
    the key, as a String.

Class TrackScheme

Field Summary

Fields inherited from class fiji.plugin.trackmate.visualization.AbstractTrackMateModelView

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INFO_TEXT

DEFAULT_COLOR

KEY

Constructor Detail

TrackScheme

Method Detail

setSpotImageUpdater

getSelectionModel

getUnlaidSpotColumn

getNextFreeColumn

getGUI

getGraph

getGraphLayout

addEdgeManually

selectionChanged

centerViewOn

modelChanged

render

refresh

clear

getModel

toggleLinking

toggleThumbnail

zoomIn

zoomOut

resetZoom

doTrackStyle

doTrackLayout

captureUndecorated

captureDecorated

toggleDisplayDecoration

linkSpots

removeSelectedCells

selectTrack

getKey