Package PamView.symbol

Class PamSymbolChooser

java.lang.Object
PamView.symbol.PamSymbolChooser
Direct Known Subclasses:
CyclicColourSymbolChooser, StandardSymbolChooser
public abstract class PamSymbolChooser extends Object
Manage symbol choices for a single display and datablock.
Author:
dg50

  • Constructor Details

  • Method Details

    • getSymbolChoice

      public abstract SymbolData getSymbolChoice(GeneralProjector projector, PamDataUnit dataUnit)
      Get the symbol choice for a data unit. e.g. clicks
      Parameters:
      projector -
      dataUnit -
      Returns:

    • getPamSymbolFX

      public PamSymbolFX getPamSymbolFX(GeneralProjector projector, PamDataUnit dataUnit)

    • getPamSymbol

      public PamSymbol getPamSymbol(GeneralProjector projector, PamDataUnit dataUnit)

    • getPamDataBlock

      public PamDataBlock getPamDataBlock()
      Returns:
      the pamDataBlock

    • getDisplayName

      public String getDisplayName()
      Returns:
      the displayName

    • getSwingOptionsPanel

      public SwingSymbolOptionsPanel getSwingOptionsPanel(GeneralProjector projector)
      Swing version of option pane. Panel which contains options to change symbol types and colours depending on detection type.
      Parameters:
      projector - - the geenral projector
      Returns:
      the JavaFX options pane for symbols.

    • getFXOptionPane

      public FXSymbolOptionsPane getFXOptionPane(GeneralProjector projector)
      The JavaFX version of the option panel. Pane which contains options to change symbol types and colours depending on detection type.
      Parameters:
      projector - - the geenral projector
      Returns:
      the JavaFX options pane for symbols.

    • getProjector

      public GeneralProjector getProjector()
      The generla projector associated with the symbol chooser.
      Returns:
      the projector

    • setProjector

      public void setProjector(GeneralProjector projector)
      Set the projector. Important for getting the right display options such as line length on the map
      Parameters:
      projector - projector to set.

    • hasSymbolModifier

      public SymbolModifier hasSymbolModifier(SymbolModifier symbolModifier)
      Check to see if a symbol modifier of a given class already exists. May have to change this so that it's by name since only one of each class is allowed in current system.
      Parameters:
      modifierClass -
      Returns:

    • addSymbolModifier

      public void addSymbolModifier(SymbolModifier symbolModifier)
      Add a symbol modifier. Don't add if one of same class already exists. Generally this function is called from the symbol manager which will add the appropriate additional modifiers.
      Parameters:
      symbolModifier -

    • addSymbolModifier

      public void addSymbolModifier(SymbolModifier symbolModifier, int position)
      Add a symbol modifier at a specific position in the list. Can be used to get a module specific modifier higher up the list, e.g. click type modifier coming before click event modifier.
      Parameters:
      symbolModifier - symbol modifier
      position - position, 0 = first in list

    • addSymbolModifier

      public void addSymbolModifier(SymbolModifier symbolModifier, Class insertAfter)
      Add a symbol modifier directly after a different symbol modifier of a given class. Can use this function to put a symbol modifier as a specific position in the list. If a modifier of the other class can't be found, it will be put at the end of the list.
      Parameters:
      symbolModifier - Symbol modifier
      insertAfter - Class of the symbol modifier that should be immediately before this one.

    • getSymbolModifiers

      public ArrayList<SymbolModifier> getSymbolModifiers()
      Get the full list of symbol modifiers. don't add to them here though, this is just for use in the dialog and other internal functions.
      Returns:
      full list of symbol modifiers.

    • removeSymbolModifier

      public boolean removeSymbolModifier(Class modifierClass)
      Remove a symbol modifier based on it's class.
      Parameters:
      modifierClass -
      Returns:
      true if it existed.

    • setSymbolOptions

      public abstract void setSymbolOptions(PamSymbolOptions symbolOptions)

    • getSymbolOptions

      public abstract PamSymbolOptions getSymbolOptions()