Package PamView.symbol

Class StandardSymbolChooser

java.lang.Object

PamView.symbol.PamSymbolChooser

PamView.symbol.StandardSymbolChooser

Direct Known Subclasses:

ClickDetSymbolChooser, ClickEventSymbolChooser, LoggerSymbolChooser, WhistleSymbolChooser

public class StandardSymbolChooser
extends PamSymbolChooser

Constructor Summary

Constructors

Constructor	Description
StandardSymbolChooser(StandardSymbolManager standardSymbolManager, PamDataBlock pamDataBlock, String displayName, SymbolData defaultSymbol, GeneralProjector projector)

Method Summary

Modifier and Type	Method	Description
protected void	fullsumbolOptionsDialog(Window frame, SymbolUpdateMonitor component)
SymbolData	getDefaultSymbol()	Create default symbol data.
SymbolData	getFixedSymbol()	Get the current fixed signal prior to any modification.
FXSymbolOptionsPane	getFXOptionPane(GeneralProjector projector)	The JavaFX version of the option panel.
double	getMapLineLength()	Get the map line length.
ArrayList<JMenuItem>	getQuickMenuItems(Window frame, SymbolUpdateMonitor component, int whatCanChange, boolean andDetails, boolean andSuperDetoptions)
ArrayList<JMenuItem>	getQuickMenuItems(Window frame, SymbolUpdateMonitor component, String prefix, int whatCanChange, boolean andDetails)	Get some easy to use menu items which can be incorporated into a Swing (or converted to FX) menu, e.g.
SwingSymbolOptionsPanel	getSwingOptionsPanel(GeneralProjector projector)	Swing version of option pane.
SymbolData	getSymbolChoice(GeneralProjector projector, PamDataUnit dataUnit)	Get the symbol choice for a data unit.
StandardSymbolManager	getSymbolManager()	Get the symbol manager.
StandardSymbolOptions	getSymbolOptions()
protected void	selectSymbolModifier(ActionEvent e, SymbolUpdateMonitor component, SymbolModifier modifier, int whatCanChange)	Called when a modifiers main menu item is selected.
void	setSymbolOptions(PamSymbolOptions symbolOptions)
boolean	showLineLengthOption(GeneralProjector projector)
boolean	showLinesToLatLongs()	Show lines to detections that have a lat long (or range invalid input: '&' bearing).

Methods inherited from class PamView.symbol.PamSymbolChooser

addSymbolModifier, addSymbolModifier, addSymbolModifier, getDisplayName, getPamDataBlock, getPamSymbol, getPamSymbolFX, getProjector, getSymbolModifiers, hasSymbolModifier, removeSymbolModifier, setProjector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StandardSymbolChooser

public StandardSymbolChooser(StandardSymbolManager standardSymbolManager,
 PamDataBlock pamDataBlock,
 String displayName,
 SymbolData defaultSymbol,
 GeneralProjector projector)

Method Details

getFixedSymbol

public SymbolData getFixedSymbol()

Get the current fixed signal prior to any modification.

Returns:

the fixed symbol.

getSymbolChoice

public SymbolData getSymbolChoice(GeneralProjector projector,
 PamDataUnit dataUnit)

Description copied from class: PamSymbolChooser

Get the symbol choice for a data unit. e.g. clicks

Specified by:

getSymbolChoice in class PamSymbolChooser

Parameters:

projector -

dataUnit -

Returns:

getQuickMenuItems

public ArrayList<JMenuItem> getQuickMenuItems(Window frame,
 SymbolUpdateMonitor component,
 int whatCanChange,
 boolean andDetails,
 boolean andSuperDetoptions)

getQuickMenuItems

public ArrayList<JMenuItem> getQuickMenuItems(Window frame,
 SymbolUpdateMonitor component,
 String prefix,
 int whatCanChange,
 boolean andDetails)

Get some easy to use menu items which can be incorporated into a Swing (or converted to FX) menu, e.g. in the click detector where we want to still quickly flick between the different colour options.

Returns:

selectSymbolModifier

protected void selectSymbolModifier(ActionEvent e,
 SymbolUpdateMonitor component,
 SymbolModifier modifier,
 int whatCanChange)

Called when a modifiers main menu item is selected.
Its not very clear what to do here, whether to select just that one, or to toggle its state or what. Probably really need a new menu to pop up with checkboxes for the different options ? Might override this for the click detector so that we can easily recreate the existing functionality of the old system.

Parameters:

e -

component -

modifier -

whatCanChange -

fullsumbolOptionsDialog

protected void fullsumbolOptionsDialog(Window frame,
 SymbolUpdateMonitor component)

getDefaultSymbol

public SymbolData getDefaultSymbol()

Create default symbol data.

Returns:

default symvoil, data.

showLineLengthOption

public boolean showLineLengthOption(GeneralProjector projector)

getSwingOptionsPanel

public SwingSymbolOptionsPanel getSwingOptionsPanel(GeneralProjector projector)

Description copied from class: PamSymbolChooser

Swing version of option pane. Panel which contains options to change symbol types and colours depending on detection type.

Overrides:

getSwingOptionsPanel in class PamSymbolChooser

Parameters:

projector - - the geenral projector

Returns:

the JavaFX options pane for symbols.

getFXOptionPane

public FXSymbolOptionsPane getFXOptionPane(GeneralProjector projector)

Description copied from class: PamSymbolChooser

The JavaFX version of the option panel. Pane which contains options to change symbol types and colours depending on detection type.

Overrides:

getFXOptionPane in class PamSymbolChooser

Parameters:

projector - - the geenral projector

Returns:

the JavaFX options pane for symbols.

getSymbolOptions

public StandardSymbolOptions getSymbolOptions()

Specified by:

getSymbolOptions in class PamSymbolChooser

Returns:

the symbolOptions

getMapLineLength

public double getMapLineLength()

Get the map line length.

Returns:

the default map line length

showLinesToLatLongs

public boolean showLinesToLatLongs()

Show lines to detections that have a lat long (or range invalid input: '&' bearing). Hiding these can make the map a lot less cluttered.

Returns:

true if lines are to be drawn.

setSymbolOptions

public void setSymbolOptions(PamSymbolOptions symbolOptions)

Specified by:

setSymbolOptions in class PamSymbolChooser

getSymbolManager

public StandardSymbolManager getSymbolManager()

Get the symbol manager.

Returns:

the symbol manager