WizardSequence (Fiji Javadocs 0-SNAPSHOT API)

All Known Implementing Classes:

TrackMateWizardSequence
```
public interface WizardSequence
```
Interface for classes that allows specifying what descriptors are traversed in the Wizard.

Author:

Jean-Yves Tinevez

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`WizardPanelDescriptor`	`configDescriptor()` Returns the descriptor in charge of configure the views.
`WizardPanelDescriptor`	`current()` Returns the descriptor currently displayed.
`boolean`	`hasNext()` Returns `true` if the sequence has an element after the current one.
`boolean`	`hasPrevious()` Returns `true` if the sequence has an element before the current one.
`WizardPanelDescriptor`	`logDescriptor()` Returns the descriptor in charge of logging events.
`WizardPanelDescriptor`	`next()` Returns the next descriptor to display.
`default void`	`onClose()` Method called when the wizard is closed.
`WizardPanelDescriptor`	`previous()` Returns the previous descriptor to display.
`default JFrame`	`run(String title)` Launches the wizard to play this sequence.
`WizardPanelDescriptor`	`save()` Returns the panel in charge of saving the data.
`void`	`setCurrent(String panelIdentifier)` Position the sequence so that its current descriptor is the one with the specified identifier.

- Method Detail
  - run
```
default JFrame run(String title)
```
    Launches the wizard to play this sequence.
    
    Returns:
    
    the JFrame in which the wizard is displayed.
  - onClose
```
default void onClose()
```
    Method called when the wizard is closed.
  - current
```
WizardPanelDescriptor current()
```
    Returns the descriptor currently displayed.
    
    Returns:
    
    the descriptor currently displayed
  - next
```
WizardPanelDescriptor next()
```
    Returns the next descriptor to display. Returns null if the sequence is finished and does not have a next descriptor.
    
    Returns:
    
    the next descriptor to display.
  - previous
```
WizardPanelDescriptor previous()
```
    Returns the previous descriptor to display. Returns null if the sequence is starting and does not have a previous descriptor.
    
    Returns:
    
    the previous descriptor to display.
  - logDescriptor
```
WizardPanelDescriptor logDescriptor()
```
    Returns the descriptor in charge of logging events. It can be accessed out of the normal sequence by a special button in the wizard.
    
    Returns:
    
    the descriptor in charge of logging events.
  - configDescriptor
```
WizardPanelDescriptor configDescriptor()
```
    Returns the descriptor in charge of configure the views. It can be accessed out of the normal sequence by a special button in the wizard.
    
    Returns:
    
    the descriptor in charge of configuring the views.
  - hasNext
```
boolean hasNext()
```
    Returns true if the sequence has an element after the current one.
    
    Returns:
    
    true if the sequence has an element after the current one.
  - hasPrevious
```
boolean hasPrevious()
```
    Returns true if the sequence has an element before the current one.
    
    Returns:
    
    true if the sequence has an element before the current one.
  - save
```
WizardPanelDescriptor save()
```
    Returns the panel in charge of saving the data.
    
    Returns:
    
    the panel in charge of saving the data.
  - setCurrent
```
void setCurrent(String panelIdentifier)
```
    Position the sequence so that its current descriptor is the one with the specified identifier. If the identifier is unknown to the sequence, do nothing.
    
    Parameters:
    
    panelIdentifier - the descriptor identifier.

Interface WizardSequence

Method Summary

Method Detail

run

onClose

current

next

previous

logDescriptor

configDescriptor

hasNext

hasPrevious

save

setCurrent