Package PamView.symbol

Class StandardSymbolManager

java.lang.Object
PamView.symbol.PamSymbolManager<StandardSymbolChooser>
PamView.symbol.StandardSymbolManager
All Implemented Interfaces:
PamSettings, SettingsNameProvider
Direct Known Subclasses:
ClickDetSymbolManager, ClickTrainSymbolManager, ClipSymbolManager, CPODSymbolManager, DLSymbolManager, GPLSymbolManager, Group3DSymbolManager, LoggerSymbolManager, PredictionSymbolManager, RWESymbolManager, SuperDetectionSymbolManager, SymbolOnlyManager, UnconfirmedCTSymbolManager, WhistleSymbolManager
public class StandardSymbolManager extends PamSymbolManager<StandardSymbolChooser>

  • Field Details

    • HAS_CHANNEL_OPTIONS

      public static final int HAS_CHANNEL_OPTIONS
      The symbol has option to colour by channels
      See Also:

    • HAS_SPECIAL_COLOUR

      public static final int HAS_SPECIAL_COLOUR
      The symbol has channels
      See Also:

    • HAS_LINE

      public static final int HAS_LINE
      Has a line to colour. e.g. whistles or bearing
      See Also:

    • HAS_LINE_LENGTH

      public static final int HAS_LINE_LENGTH
      Has a line length to change e.g bearings.
      See Also:

    • HAS_LINE_AND_LENGTH

      public static final int HAS_LINE_AND_LENGTH
      Save typing by adding has line and has line length together.
      See Also:

    • HAS_SYMBOL

      public static final int HAS_SYMBOL
      Has a symbol e.g. clicks and whistles.
      See Also:

    • NUM_STANDARD_CHOICES

      public static final int NUM_STANDARD_CHOICES
      Number of standard colour choices
      See Also:

  • Constructor Details

    • StandardSymbolManager

      public StandardSymbolManager(PamDataBlock pamDataBlock, SymbolData defaultSymbol)
      Constructor for a standard symbol manager, requiring an associated datablock and a standard symbol. Enabling colouring by channel is set to true and the special colour names is set to null.
      Parameters:
      pamDataBlock - Data Block
      defaultSymbol - Default Symbol

    • StandardSymbolManager

      public StandardSymbolManager(PamDataBlock pamDataBlock, SymbolData defaultSymbol, boolean hasChannelOption)
      Constructor for a standard symbol manager, requiring an associated datablock and a standard symbol. Enabling colouring by channel is set to true and the special colour names is set to null.
      Parameters:
      pamDataBlock - Data Block
      defaultSymbol - Default Symbol
      hasChannelOption -

    • StandardSymbolManager

      public StandardSymbolManager(PamDataBlock pamDataBlock, SymbolData defaultSymbol, boolean hasChannelOption, String specialColourName)
      Constructor for a standard symbol manager, requiring an associated datablock and a standard symbol.
      Parameters:
      pamDataBlock - Data Block
      defaultSymbol - Default Symbol
      hasChannelOption - colour by channel option is available
      specialColourName - colour by special name is available.

    • StandardSymbolManager

      public StandardSymbolManager(PamDataBlock pamDataBlock, SymbolData defaultSymbol, String specialColourName)
      Constructor for a standard symbol manager, requiring an associated datablock and a standard symbol. Enabling colouring by channel is set to true and the special colour names is set to null.
      Parameters:
      pamDataBlock - Data Block
      defaultSymbol - Default Symbol
      specialColourName -

  • Method Details

    • getSpecialColourName

      public String getSpecialColourName()
      Returns:
      the specialColourName

    • setSpecialColourName

      public void setSpecialColourName(String specialColourName)
      Parameters:
      specialColourName - the specialColourName to set

    • colourChoiceName

      public String colourChoiceName(int iChoice)

    • getDefaultSymbol

      public SymbolData getDefaultSymbol()
      Returns:
      the defaultSymbol

    • setDefaultSymbol

      public void setDefaultSymbol(SymbolData defaultSymbol)
      Parameters:
      defaultSymbol - the defaultSymbol to set

    • addSymbolOption

      public int addSymbolOption(int symbolChoice)
      Add an option to the symbol manager
      Parameters:
      flag - - integer flag.
      Returns:
      true if the manager has the option enabled.

    • removeSymbolOption

      public int removeSymbolOption(int symbolChoice)
      Check whether the symbol manager has a symbol option.
      Parameters:
      flag - - integer flag.
      Returns:
      true if the manager has the option enabled.

    • hasSymbolOption

      public boolean hasSymbolOption(int symbolChoice)
      Parameters:
      symbolChoice -

    • addSymbolChnageListener

      public void addSymbolChnageListener(SymbolChangeListener symbolChangeListener)
      Add a symbol chnage listener
      Parameters:
      symbolChangeListener - the

    • removeSymbolChnageListener

      public void removeSymbolChnageListener(SymbolChangeListener symbolChangeListener)
      Remove a symbol change listener
      Parameters:
      symbolChangeListener - the

    • notifySymbolListeners

      public void notifySymbolListeners(StandardSymbolChooser chooser)
      Notify all listeners that a symbolChooser has changed.
      Parameters:
      chooser - the chooser which has changed.

    • getNColourChoices

      public int getNColourChoices()
      The number of available colour choices.
      Returns:
      the number of colour choices.