PamView

Class PamColors

java.lang.Object

PamView.PamColors

All Implemented Interfaces:

PamSettings

public class PamColors
extends java.lang.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PamColors.PamColor

Field Summary

Fields

Modifier and Type	Field and Description
int	NWHALECOLORS

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Font	getBoldFont()
static java.awt.Color	getBorderColour() Get the standard border colour
java.awt.Color	getChannelColor(int iChan)
java.awt.Color	getColor(PamColors.PamColor col)
ColorSettings	getColorSettings()
java.awt.Color	getForegroudColor(PamColors.PamColor col)
static PamColors	getInstance()
static java.lang.String	getLoggerColourString(java.awt.Color col) Get a colour string in the format (RRR,GGG,BBB)
javax.swing.JMenuItem	getMenu()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
java.awt.Color	getWhaleColor(int col)
static java.awt.Color	interpretColourString(java.lang.String colString) Interpret a colour string of the type used in Logger forms.
void	notifyContianer(java.awt.Container container) Tells a container to set it's colour and the colour of all it's components if they implement the ColorManaged interface.
void	notifyModelChanged(int changeType)
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setColor(java.awt.Component component, PamColors.PamColor col) Color a component immediately.
void	setColors()
void	setDayTime()
void	setNightTime()

Methods inherited from class java.lang.Object

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

Field Detail

NWHALECOLORS

public final int NWHALECOLORS

See Also:

Constant Field Values

Method Detail

getMenu

public javax.swing.JMenuItem getMenu()

setNightTime

public void setNightTime()

setDayTime

public void setDayTime()

getInstance

public static PamColors getInstance()

notifyModelChanged

public void notifyModelChanged(int changeType)

setColors

public void setColors()

notifyContianer

public void notifyContianer(java.awt.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(java.awt.Component component,
            PamColors.PamColor col)

Color a component immediately.

Parameters:

component -

col -

getColor

public java.awt.Color getColor(PamColors.PamColor col)

getForegroudColor

public java.awt.Color getForegroudColor(PamColors.PamColor col)

getWhaleColor

public java.awt.Color getWhaleColor(int col)

getChannelColor

public java.awt.Color getChannelColor(int iChan)

getBoldFont

public java.awt.Font getBoldFont()

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

getColorSettings

public ColorSettings getColorSettings()

interpretColourString

public static java.awt.Color interpretColourString(java.lang.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 java.lang.String getLoggerColourString(java.awt.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 static java.awt.Color getBorderColour()

Get the standard border colour

Returns:

border colour.