AbstractCtrl (FLIMLib Javadocs 0-SNAPSHOT API)

java.lang.Object
- flimlib.flimj.ui.controller.AbstractCtrl

Direct Known Subclasses:

ExportCtrl, MainCtrl, PlotCtrl, PreviewCtrl, PreviewCtrl.CBPopOverCtrl, SettingsCtrl
```
public abstract class AbstractCtrl
extends Object
```
The basis for a tab controller that is Initializable and refreshable by both external control flow and other controllers backed by the same fit processor.

Field Summary

Fields
Modifier and Type Field and Description

protected FitProcessor fp

static String FXML_DIR

protected AbstractCtrl parentCtrl

Fields
Modifier and Type	Field and Description
`protected FitProcessor`	`fp`
`static String`	`FXML_DIR`
`protected AbstractCtrl`	`parentCtrl`

Constructor Summary

Constructors
Constructor and Description

AbstractCtrl()

Constructors
Constructor and Description
`AbstractCtrl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Release the reources occupied by fields in the controller (e.g.
`protected DatasetIOService`	`getDss()` Gets the dataset service in context.
`static FXMLLoader`	`getFXMLLoader(String name)`
`protected FitParams<FloatType>`	`getIRFInfo()` Retrieves the current IRF information parameter.
`protected LogService`	`getLogs()` Gets the log service in context.
`protected ObjectService`	`getObs()` Gets the object service in context.
`protected OpService`	`getOps()` Gets the Op service in context.
`protected FitParams<FloatType>`	`getParams()` Retrieves the current fitting parameter.
`protected FitResults`	`getResults()` Retrieves the current fitted results.
`protected UIService`	`getUIs()` Gets the UI service in context.
`void`	`initialize()`
`protected void`	`refresh(FitParams<FloatType> params, FitResults results)` The callback called when the controller is supposed to refresh itself based on the parameters and the results provided by the arguments.
`void`	`requestRefresh()` Called by external control flow to notify the controller to refresh itself.
`protected void`	`requestUpdate()` Called by the controller to notify the fit processor to perform a fit and other controllers to update themselves based on the fit results.
`void`	`setFitProcessor(FitProcessor fp)` Sets the fit processor behind the controller.
`void`	`setParentCtrl(AbstractCtrl parentCtrl)` Sets the parent controller of this controller.

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

- Field Detail
  - FXML_DIR
```
public static final String FXML_DIR
```
    See Also:
    
    Constant Field Values
  - fp
```
protected FitProcessor fp
```
  - parentCtrl
```
protected AbstractCtrl parentCtrl
```
- Constructor Detail
  - AbstractCtrl
```
public AbstractCtrl()
```
- Method Detail
  - getFXMLLoader
```
public static FXMLLoader getFXMLLoader(String name)
                                throws IOException
```
    Throws:
    
    IOException
  - initialize
```
public void initialize()
```
  - setFitProcessor
```
public void setFitProcessor(FitProcessor fp)
```
    Sets the fit processor behind the controller.
    
    Parameters:
    
    fp - the fit processor
  - setParentCtrl
```
public void setParentCtrl(AbstractCtrl parentCtrl)
```
    Sets the parent controller of this controller.
    
    Parameters:
    
    parentCtrl - the parent controller of this controller
  - requestRefresh
```
public void requestRefresh()
```
    Called by external control flow to notify the controller to refresh itself.
  - destroy
```
public void destroy()
```
    Release the reources occupied by fields in the controller (e.g. fp).
  - getParams
```
protected FitParams<FloatType> getParams()
```
    Retrieves the current fitting parameter.
    
    Returns:
    
    the current fitting parameter
  - getIRFInfo
```
protected FitParams<FloatType> getIRFInfo()
```
    Retrieves the current IRF information parameter.
    
    Returns:
    
    the current IRF information
  - getResults
```
protected FitResults getResults()
```
    Retrieves the current fitted results.
    
    Returns:
    
    the current fitted results
  - getOps
```
protected OpService getOps()
```
    Gets the Op service in context.
    
    Returns:
    
    the Op service
  - getUIs
```
protected UIService getUIs()
```
    Gets the UI service in context.
    
    Returns:
    
    the UI service
  - getObs
```
protected ObjectService getObs()
```
    Gets the object service in context.
    
    Returns:
    
    the object service
  - getDss
```
protected DatasetIOService getDss()
```
    Gets the dataset service in context.
    
    Returns:
    
    the dataset service
  - getLogs
```
protected LogService getLogs()
```
    Gets the log service in context.
    
    Returns:
    
    the log service
  - requestUpdate
```
protected void requestUpdate()
```
    Called by the controller to notify the fit processor to perform a fit and other controllers to update themselves based on the fit results.
  - refresh
```
protected void refresh(FitParams<FloatType> params,
                       FitResults results)
```
    The callback called when the controller is supposed to refresh itself based on the parameters and the results provided by the arguments.
    
    Parameters:
    
    params - the active fitting parameter
    
    results - the active fitted results

Class AbstractCtrl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FXML_DIR

fp

parentCtrl

Constructor Detail

AbstractCtrl

Method Detail

getFXMLLoader

initialize

setFitProcessor

setParentCtrl

requestRefresh

destroy

getParams

getIRFInfo

getResults

getOps

getUIs

getObs

getDss

getLogs

requestUpdate

refresh