jspecview.common

Class DisplayScheme

java.lang.Object

jspecview.common.DisplayScheme

Direct Known Subclasses:

Parameters

public class DisplayScheme
extends Object

This a representation of the Display Scheme for the spectral display.

Author:

Debbie-Ann Facey, Khari A. Bryan, Prof Robert J. Lancashire

See Also:

JSVPanel

Field Summary

Fields

Modifier and Type	Field and Description
protected String	displayFont The name of the display font
protected Map<jspecview.common.ScriptToken,Color>	elementColors A map of the name of the elements and their colors
protected boolean	isDefault Specifies if the display scheme is the default
protected String	name The name of the DisplayScheme
protected String	titleFont The name of the title font

Constructor Summary

Constructors

Constructor and Description
DisplayScheme(String name) Intialises a DisplayScheme with the given name

Method Summary

Methods

Modifier and Type	Method and Description
DisplayScheme	copy() Returns a copy of this DisplayScheme
DisplayScheme	copy(String newName) Returns a copy of this DisplayScheme with a new name
Color	getColor(jspecview.common.ScriptToken st) Gets the color of an element in the scheme
Map<jspecview.common.ScriptToken,Color>	getColors()
String	getDisplayFont() Returns the font name used in this DisplayScheme
String	getName() Returns the name of the DisplayScheme
String	getTitleFont()
boolean	isDefault() Returns whether or not the DisplayScheme is the default
Color	setColor(jspecview.common.ScriptToken st, Color color) Sets the color of an element
void	setDefault(boolean val) Sets whether the DisplayScheme is the default
protected void	setDefaults()
void	setDisplayFont(String fontName) Sets the font name
void	setName(String name) Sets the name of the DisplayScheme
void	setTitleFont(String fontName) Sets the title font name

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

The name of the DisplayScheme

titleFont

protected String titleFont

The name of the title font

displayFont

protected String displayFont

The name of the display font

elementColors

protected Map<jspecview.common.ScriptToken,Color> elementColors

A map of the name of the elements and their colors

isDefault

protected boolean isDefault

Specifies if the display scheme is the default

Constructor Detail

DisplayScheme

public DisplayScheme(String name)

Intialises a DisplayScheme with the given name

Parameters:

name - the name of the DisplayScheme

Method Detail

getColors

public Map<jspecview.common.ScriptToken,Color> getColors()

getName

public String getName()

Returns the name of the DisplayScheme

Returns:

the name of the DisplayScheme

setName

public void setName(String name)

Sets the name of the DisplayScheme

Parameters:

name - the name

getTitleFont

public String getTitleFont()

Returns:

the title font name used in this DisplayScheme

setTitleFont

public void setTitleFont(String fontName)

Sets the title font name

Parameters:

fontName - the name of the font

getDisplayFont

public String getDisplayFont()

Returns the font name used in this DisplayScheme

Returns:

the font name used in this DisplayScheme

setDisplayFont

public void setDisplayFont(String fontName)

Sets the font name

Parameters:

fontName - the name of the font

setDefault

public void setDefault(boolean val)

Sets whether the DisplayScheme is the default

Parameters:

val - is true if default, otherwise false

isDefault

public boolean isDefault()

Returns whether or not the DisplayScheme is the default

Returns:

true if default, false otherwise

getColor

public Color getColor(jspecview.common.ScriptToken st)

Gets the color of an element in the scheme

Parameters:

element - the name of the element

Returns:

the Color of the element

setColor

public Color setColor(jspecview.common.ScriptToken st,
             Color color)

Sets the color of an element

Parameters:

element - the name of the element

color - the color the element should have

copy

public DisplayScheme copy(String newName)

Returns a copy of this DisplayScheme with a new name

Parameters:

newName - the new name

Returns:

a copy of this DisplayScheme with a new name

copy

public DisplayScheme copy()

Returns a copy of this DisplayScheme

Returns:

a copy of this DisplayScheme

setDefaults

protected void setDefaults()