ClickBTDisplay

java.lang.Object
- Layout.PamFramePlots
- - clickDetector.ClickDisplay
  - - clickDetector.ClickBTDisplay

All Implemented Interfaces:

PamSettings, PamObserver
```
public class ClickBTDisplay
extends ClickDisplay
implements PamObserver, PamSettings
```
This is the main bearing time display for the click detector.

Author:

Doug Gillespie

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ClickBTDisplay.FollowBoxListener

class ClickBTDisplay.PlotKeyListener

Nested Classes
Modifier and Type	Class and Description
`class`	`ClickBTDisplay.FollowBoxListener`
`class`	`ClickBTDisplay.PlotKeyListener`

Field Summary

Fields
Modifier and Type Field and Description

PamLabel cursorLabel

RangeSpinner rangeSpinner

Fields
Modifier and Type	Field and Description
`PamLabel`	`cursorLabel`
`RangeSpinner`	`rangeSpinner`

Constructor Summary

Constructors
Constructor and Description
`ClickBTDisplay(ClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clickedOnClick(ClickDetection click)`
`void`	`created()`
`BTDisplayParameters`	`getBtDisplayParameters()`
`static PamSymbol`	`getClickSymbol(ClickIdentifier clickIdentifier, ClickDetection click, int colourType)`
`CtrlKeyManager`	`getCtrlKeyManager()`
`int`	`getDisplayChannels()`
`java.util.ArrayList<ClickDetection>`	`getMarkedClicks()`
`java.lang.String`	`getName()`
`java.lang.String`	`getObserverName()`
`PamObserver`	`getObserverObject()`
`long`	`getRequiredDataHistory(PamObservable o, java.lang.Object arg)`
`ClickDetection`	`getSelectedClick()`
`java.io.Serializable`	`getSettingsReference()`
`long`	`getSettingsVersion()`
`java.lang.String`	`getUnitName()`
`java.lang.String`	`getUnitType()`
`void`	`gotoEvent(OfflineEventDataUnit event)` Scroll the display to a specific event.
`void`	`makeMarkedClickList()` Called when a zoom polygon has been completed and immediately makes a list of all marked clicks.
`void`	`masterClockUpdate(long milliSeconds, long sampleNumber)`
`void`	`newClick(ClickDetection clickDataUnit)`
`void`	`newRawData(PamDataBlock rawDataBlock, RawDataUnit newRawData)` during real time operation the scrolling is all controlled by the arrival of new raw data unis observed by the BT display.
`void`	`newScrollTimingData(long millis)`
`void`	`noteNewSettings()`
`void`	`notifyNewStorage(java.lang.String storageName)`
`void`	`offlineDataChanged()` Called from clicksOffline when data have changed (eg from re doing click id).
`void`	`pamStart()`
`void`	`playClicks()`
`void`	`playViewerData()` Play the first two channels in the channel list for this display.
`void`	`removeObservable(PamObservable o)` called when an Observable (PamDataBlock) is removed from the system
`void`	`repaintBoth()` Repaints both the plot and the axis panel
`void`	`repaintTotal()` Repaints forcing a redrawing of all click.
`boolean`	`restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)`
`void`	`setDisplayChannels(int displayChannels)`
`void`	`setSampleRate(float sampleRate, boolean notify)` New sample rate
`void`	`setSelectedClick(ClickDetection selectedClick)`
`void`	`update(PamObservable obs, PamDataUnit newData)` Informs the PamObserver that new data have been added to the Observable class

Methods inherited from class clickDetector.ClickDisplay
getClickDisplayInfo, pamStop

Methods inherited from class Layout.PamFramePlots
checkDualDisplay, getAxisPanel, getCopyMenuItem, getEastPanel, getFrame, getLeftPlotPanel, getNorthPanel, getPlotPanel, getRightPlotPanel, getSouthPanel, getWestPanel, repaint, setAxisPanel, setEastPanel, setFrame, setLeftPlotPanel, setNorthPanel, setPlotPanel, setRightPlotPanel, setSouthPanel, setWestPanel

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

- Field Detail
  - cursorLabel
```
public PamLabel cursorLabel
```
  - rangeSpinner
```
public RangeSpinner rangeSpinner
```
- Constructor Detail
  - ClickBTDisplay
```
public ClickBTDisplay(ClickControl clickControl,
              ClickDisplayManager clickDisplayManager,
              clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)
```
- Method Detail
  - getObserverObject
```
public PamObserver getObserverObject()
```
    Specified by:
    
    getObserverObject in interface PamObserver
    
    Returns:
    the actual observer. In most cases concrete classes will just return 'this' in response. The exception is the Threaded observer, which will return the single thread observer.
  - created
```
public void created()
```
    Overrides:
    
    created in class ClickDisplay
  - getRequiredDataHistory
```
public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)
```
    Specified by:
    
    getRequiredDataHistory in interface PamObserver
    
    Parameters:
    o - PamObservable class requiring the data
    arg - optional argument from PamObservable
    
    Returns:
    time in milliseconds requried by data held in PamObservable
  - update
```
public void update(PamObservable obs,
          PamDataUnit newData)
```
    Description copied from interface: PamObserver
    
    Informs the PamObserver that new data have been added to the Observable class
    
    Specified by:
    
    update in interface PamObserver
    
    Parameters:
    obs - Reference to the Observable (a PamDataBlock)
    newData - Reference to the new PamDataUnit
  - newClick
```
public void newClick(ClickDetection clickDataUnit)
```
  - newRawData
```
public void newRawData(PamDataBlock rawDataBlock,
              RawDataUnit newRawData)
```
    during real time operation the scrolling is all controlled by the arrival of new raw data unis observed by the BT display. This is now delegated to newScrollTimingData so that it cab be called for clicks arriving from the network receiver.
    
    Parameters:
    rawDataBlock -
    newRawData -
  - newScrollTimingData
```
public void newScrollTimingData(long millis)
```
  - getObserverName
```
public java.lang.String getObserverName()
```
    Specified by:
    
    getObserverName in interface PamObserver
  - setSampleRate
```
public void setSampleRate(float sampleRate,
                 boolean notify)
```
    Description copied from interface: PamObserver
    
    New sample rate
    
    Specified by:
    
    setSampleRate in interface PamObserver
    
    notify - Notify other PamObservers and PamObservables in the chain.
  - masterClockUpdate
```
public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)
```
    Specified by:
    
    masterClockUpdate in interface PamObserver
  - offlineDataChanged
```
public void offlineDataChanged()
```
    Description copied from class: ClickDisplay
    
    Called from clicksOffline when data have changed (eg from re doing click id). Needs to notify the display and maybe some other classes.
    
    Overrides:
    
    offlineDataChanged in class ClickDisplay
  - repaintBoth
```
public void repaintBoth()
```
    Repaints both the plot and the axis panel
  - repaintTotal
```
public void repaintTotal()
```
    Repaints forcing a redrawing of all click. Use this to redraw plot from other packages.
  - getClickSymbol
```
public static PamSymbol getClickSymbol(ClickIdentifier clickIdentifier,
                       ClickDetection click,
                       int colourType)
```
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in class PamFramePlots
  - noteNewSettings
```
public void noteNewSettings()
```
    Specified by:
    
    noteNewSettings in interface PamObserver
    
    Specified by:
    
    noteNewSettings in class ClickDisplay
  - notifyNewStorage
```
public void notifyNewStorage(java.lang.String storageName)
```
  - removeObservable
```
public void removeObservable(PamObservable o)
```
    Description copied from interface: PamObserver
    
    called when an Observable (PamDataBlock) is removed from the system
    
    Specified by:
    
    removeObservable in interface PamObserver
  - pamStart
```
public void pamStart()
```
    Overrides:
    
    pamStart in class ClickDisplay
  - getDisplayChannels
```
public int getDisplayChannels()
```
  - setDisplayChannels
```
public void setDisplayChannels(int displayChannels)
```
  - getSettingsReference
```
public java.io.Serializable getSettingsReference()
```
    Specified by:
    
    getSettingsReference in interface PamSettings
    
    Returns:
    The serialisable object that will be stored
  - getSettingsVersion
```
public long getSettingsVersion()
```
    Specified by:
    
    getSettingsVersion in interface PamSettings
    
    Returns:
    An integer version number for the settings
  - getUnitName
```
public java.lang.String getUnitName()
```
    Specified by:
    
    getUnitName in interface PamSettings
    
    Returns:
    A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.
  - getUnitType
```
public java.lang.String getUnitType()
```
    Specified by:
    
    getUnitType in interface PamSettings
    
    Returns:
    A Name specific to the type, e.g. Glick detector
  - restoreSettings
```
public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
```
    Specified by:
    
    restoreSettings in interface PamSettings
    
    Returns:
    true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required
  - getSelectedClick
```
public ClickDetection getSelectedClick()
```
  - setSelectedClick
```
public void setSelectedClick(ClickDetection selectedClick)
```
  - clickedOnClick
```
public void clickedOnClick(ClickDetection click)
```
    Overrides:
    
    clickedOnClick in class ClickDisplay
  - makeMarkedClickList
```
public void makeMarkedClickList()
```
    Called when a zoom polygon has been completed and immediately makes a list of all marked clicks.
    
    Parameters:
    zoomShape -
  - getMarkedClicks
```
public java.util.ArrayList<ClickDetection> getMarkedClicks()
```
    Returns:
    a list of clicks which are within a marked area.
  - gotoEvent
```
public void gotoEvent(OfflineEventDataUnit event)
```
    Scroll the display to a specific event.
    
    Parameters:
    event - event to scroll to
  - playViewerData
```
public void playViewerData()
```
    Play the first two channels in the channel list for this display.
  - playClicks
```
public void playClicks()
```
  - getBtDisplayParameters
```
public BTDisplayParameters getBtDisplayParameters()
```
    Returns:
    the btDisplayParameters
  - getCtrlKeyManager
```
public CtrlKeyManager getCtrlKeyManager()
```
    Returns:
    the ctrlKeyManager

Class ClickBTDisplay

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class clickDetector.ClickDisplay

Methods inherited from class Layout.PamFramePlots

Methods inherited from class java.lang.Object

Field Detail

cursorLabel

rangeSpinner

Constructor Detail

ClickBTDisplay

Method Detail

getObserverObject

created

getRequiredDataHistory

update

newClick

newRawData

newScrollTimingData

getObserverName

setSampleRate

masterClockUpdate

offlineDataChanged

repaintBoth

repaintTotal

getClickSymbol

getName

noteNewSettings

notifyNewStorage

removeObservable

pamStart

getDisplayChannels

setDisplayChannels

getSettingsReference

getSettingsVersion

getUnitName

getUnitType

restoreSettings

getSelectedClick

setSelectedClick

clickedOnClick

makeMarkedClickList

getMarkedClicks

gotoEvent

playViewerData

playClicks

getBtDisplayParameters

getCtrlKeyManager