Package PamView

Class PamColors

java.lang.Object
PamView.PamColors
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class PamColors extends Object implements PamSettings
Author:
Doug Gillespie Some standard colours to use for various bits of a view.

Ultimately, it should be possible to set these dynamically during operation or have night / day settings, etc.

Any bit of the display can register with a single instance of PamColors and it will then receive notifications whenever any of the colours change.

  • Method Details

    • getMenu

      public JMenuItem getMenu(JFrame parentFrame)

    • getInstance

      public static PamColors getInstance()

    • notifyModelChanged

      public void notifyModelChanged(int changeType)

    • setColors

      public void setColors()

    • notifyContianer

      public void notifyContianer(Container container)
      Tells a container to set it's colour and the colour of all it's components if they implement the ColorManaged interface.

      Generally this should be called initially for each frame to start the iteration through all the swing components.

      Parameters:
      container - container / or frame to start searching from

    • setColor

      public void setColor(Component component, PamColors.PamColor col)
      Color a component immediately.
      Parameters:
      component -
      col -

    • getColor

      public Color getColor(PamColors.PamColor col)

    • getForegroudColor

      public Color getForegroudColor(PamColors.PamColor col)

    • getWhaleColor

      public Color getWhaleColor(int col)

    • getChannelColor

      public Color getChannelColor(int iChan)

    • getBoldFont

      public Font getBoldFont()

    • getSettingsReference

      public 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 String getUnitName()
      Specified by:
      getUnitName in interface SettingsNameProvider
      Returns:
      A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

    • getUnitType

      public String getUnitType()
      Specified by:
      getUnitType in interface PamSettings
      Returns:
      A Name specific to the type, e.g. Click 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

    • getColorSettings

      public ColorSettings getColorSettings()

    • interpretColourString

      public static Color interpretColourString(String colString)
      Interpret a colour string of the type used in Logger forms.

      These can take two basic formats, first a colour name (e.g. blue) or a RGB code in the format RGB(RRR,GGG,BBB) where RRR, GGG and BBB are integer colour codes for red, green and blue each of which must lie between 0 and 255.

      Parameters:
      colString - Colour string
      Returns:
      colour or null if the colour cannot be interpreted.

    • getLoggerColourString

      public static String getLoggerColourString(Color col)
      Get a colour string in the format (RRR,GGG,BBB)
      Parameters:
      col - Colour
      Returns:
      null if col is null or formatted string.

    • getBorderColour

      public Color getBorderColour()
      Get the standard border colour
      Returns:
      border colour.

    • getGPSColor

      public Color getGPSColor()

    • getNWhaleColours

      public int getNWhaleColours()

    • getWhaleColourIndex

      public int getWhaleColourIndex(int iCol)

    • getColourScheme

      public ColourScheme getColourScheme()
      Returns:
      the colourScheme