StaticLocalisationMainPanel

java.lang.Object
- staticLocaliser.panels.StaticLocalisationMainPanel

All Implemented Interfaces:

PamTabPanel
```
public class StaticLocalisationMainPanel
extends java.lang.Object
implements PamTabPanel
```
Creates the entire dialog panel for the static localiser. The design aim here is to create something much along the line of microsofts user interface for word and windows eight. The user should be able to access most of the controls (bar a few advanced options) straight from the panel. Although this provides a friendly user environment it is space intensive.

Author:

Jamie Macaulay

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`StaticLocalisationMainPanel.BatchRun`
`class`	`StaticLocalisationMainPanel.LocaliserOptions`
`class`	`StaticLocalisationMainPanel.Options`
`class`	`StaticLocalisationMainPanel.Run`
`class`	`StaticLocalisationMainPanel.RunAll`
`class`	`StaticLocalisationMainPanel.RunRealTime`
`class`	`StaticLocalisationMainPanel.SelectDataBlock`
`class`	`StaticLocalisationMainPanel.Stop`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BATCH_LOCALISE`
`static java.awt.Dimension`	`controlPanelDimensions`
`static int`	`DETECTION_N_DIALOG`
`static javax.swing.ImageIcon`	`settings`

Constructor Summary

Constructors
Constructor and Description
`StaticLocalisationMainPanel(StaticLocaliserControl staticlocalisercontrol, PamDataBlock pamDataBlock)` Create the main panel of the static loclaiser.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`changeControlPanel()` Change to the control panel corresponding to the selected data block.
`void`	`create3DMap()`
`void`	`createAlgorithmPanel()`
`javax.swing.JComboBox<java.lang.String>`	`createComboDataList(boolean single)` Creates the combo box which contains the data blocks which can be localised.
`void`	`createEastPanel()` Create the east panel which contains the tdVisualisation panel and panels showing unique info from each localisation algorithm.
`javax.swing.JMenu`	`createMenu(java.awt.Frame parentFrame)`
`void`	`createNorthPanel()` Create the north panel.
`void`	`createPanels()` We must wait for intialisation to occur before creating some panels and registering datablocks.
`void`	`dataBlockListChanged()` Call this if the data blocks are changed;
`PamPanel`	`dataBlockSelectionPanel()` Creates the JPanel which holds the data block combo box.
`java.util.ArrayList<AbstractLocaliserControl>`	`getControlPanels()`
`AbstractLocaliserControl`	`getCurrentControlPanel()`
`javax.swing.JComboBox<java.lang.String>`	`getDataBlockList()`
`MapPanel3DSL`	`getDialogMap3D()`
`LocalisationInformation`	`getLocalisationInformation()`
`javax.swing.JPanel`	`getMainPanel()`
`javax.swing.JComponent`	`getPanel()`
`LocResultsPanel`	`getResultsPanel()`
`StaticLocaliserControl`	`getStaticLocaliserControl()`
`TDVisualisation`	`getTDVisualisation()`
`javax.swing.JToolBar`	`getToolBar()`
`PamPanel`	`localiserControlButtons()` Returns a JPanel with localiser control buttons.
`void`	`openOptionsDialog(int type)`
`void`	`processQueueUpdate(SLNotification slNotification)` Called when real time process queue updates
`void`	`setEnableAlgorithmSel(boolean enable)`
`void`	`setEnableLocalise(boolean enable)`
`void`	`update(int update)`
`void`	`updateComboList()` Updates the combo box list.
`void`	`updateControlPanelList()` Updates the list of control panels.

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

- Field Detail
  - settings
```
public static javax.swing.ImageIcon settings
```
  - controlPanelDimensions
```
public static java.awt.Dimension controlPanelDimensions
```
  - BATCH_LOCALISE
```
public static final int BATCH_LOCALISE
```
    See Also:
    Constant Field Values
  - DETECTION_N_DIALOG
```
public static final int DETECTION_N_DIALOG
```
    See Also:
    Constant Field Values
- Constructor Detail
  - StaticLocalisationMainPanel
```
public StaticLocalisationMainPanel(StaticLocaliserControl staticlocalisercontrol,
                           PamDataBlock pamDataBlock)
```
    Create the main panel of the static loclaiser. Note that 3D components are not called in the constructor.
    
    Parameters:
    staticlocalisercontrol -
    pamDataBlock -
- Method Detail
  - createPanels
```
public void createPanels()
```
    We must wait for intialisation to occur before creating some panels and registering datablocks. This function finishes off creating the static localiser GUI. panel.
  - createAlgorithmPanel
```
public void createAlgorithmPanel()
```
  - create3DMap
```
public void create3DMap()
```
  - createEastPanel
```
public void createEastPanel()
```
    Create the east panel which contains the tdVisualisation panel and panels showing unique info from each localisation algorithm.
  - createNorthPanel
```
public void createNorthPanel()
```
    Create the north panel. The north panel contains the detection specific control panel, the data block selection combo box and the buttons used to run/stop and configure localisations.
  - updateControlPanelList
```
public void updateControlPanelList()
```
    Updates the list of control panels. Use this function if additional data blocks are added.
  - getDialogMap3D
```
public MapPanel3DSL getDialogMap3D()
```
  - getTDVisualisation
```
public TDVisualisation getTDVisualisation()
```
  - getDataBlockList
```
public javax.swing.JComboBox<java.lang.String> getDataBlockList()
```
  - update
```
public void update(int update)
```
  - changeControlPanel
```
public void changeControlPanel()
```
    Change to the control panel corresponding to the selected data block. Sets the control panel in the mainPanel and refreshes control panel data;
  - createComboDataList
```
public javax.swing.JComboBox<java.lang.String> createComboDataList(boolean single)
```
    Creates the combo box which contains the data blocks which can be localised. Choose true if only single datablocks are to be present in the comboBox. Choose false to include unsynchrnised datablocks
  - updateComboList
```
public void updateComboList()
```
    Updates the combo box list. Use this if a new data block has been added.
  - dataBlockSelectionPanel
```
public PamPanel dataBlockSelectionPanel()
```
    Creates the JPanel which holds the data block combo box.
    
    Returns:
    JPanel with a combo box allowing selection of data blocks which satisfy the static localiser interface.
  - localiserControlButtons
```
public PamPanel localiserControlButtons()
```
    Returns a JPanel with localiser control buttons. These buttons are generic to every datablock Run- runs a localisation for a single detection RunAll -runs the localiser for a group of detections, one adetection at a time - allows batch processing Save- saves the results to a database. Stop- stops the localisation in it's tracks, results are null; Options- brings up an options panel which contains options that are generic to every localisation, no matter what the PamDetection is (be careful here);
    
    Returns:
    JPanel with localiser controls;
  - setEnableLocalise
```
public void setEnableLocalise(boolean enable)
```
  - setEnableAlgorithmSel
```
public void setEnableAlgorithmSel(boolean enable)
```
  - processQueueUpdate
```
public void processQueueUpdate(SLNotification slNotification)
```
    Called when real time process queue updates
    
    Parameters:
    slNotification -
  - openOptionsDialog
```
public void openOptionsDialog(int type)
```
  - getControlPanels
```
public java.util.ArrayList<AbstractLocaliserControl> getControlPanels()
```
  - getCurrentControlPanel
```
public AbstractLocaliserControl getCurrentControlPanel()
```
  - getStaticLocaliserControl
```
public StaticLocaliserControl getStaticLocaliserControl()
```
  - getResultsPanel
```
public LocResultsPanel getResultsPanel()
```
  - getLocalisationInformation
```
public LocalisationInformation getLocalisationInformation()
```
  - getPanel
```
public javax.swing.JComponent getPanel()
```
    Specified by:
    
    getPanel in interface PamTabPanel
    
    Returns:
    Reference to a graphics component that can be added to the view. This will typically be a JPanel or a JInternalFrame;
  - dataBlockListChanged
```
public void dataBlockListChanged()
```
    Call this if the data blocks are changed;
  - getToolBar
```
public javax.swing.JToolBar getToolBar()
```
    Specified by:
    
    getToolBar in interface PamTabPanel
    
    Returns:
    a JToolbas associated with this tab. This will only be displayed when the current tab is activated
  - getMainPanel
```
public javax.swing.JPanel getMainPanel()
```
  - createMenu
```
public javax.swing.JMenu createMenu(java.awt.Frame parentFrame)
```
    Specified by:
    
    createMenu in interface PamTabPanel
    
    Returns:
    a JMeny for the panel

Class StaticLocalisationMainPanel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

settings

controlPanelDimensions

BATCH_LOCALISE

DETECTION_N_DIALOG

Constructor Detail

StaticLocalisationMainPanel

Method Detail

createPanels

createAlgorithmPanel

create3DMap

createEastPanel

createNorthPanel

updateControlPanelList

getDialogMap3D

getTDVisualisation

getDataBlockList

update

changeControlPanel

createComboDataList

updateComboList

dataBlockSelectionPanel

localiserControlButtons

setEnableLocalise

setEnableAlgorithmSel

processQueueUpdate

openOptionsDialog

getControlPanels

getCurrentControlPanel

getStaticLocaliserControl

getResultsPanel

getLocalisationInformation

getPanel

dataBlockListChanged

getToolBar

getMainPanel

createMenu