edu.mssm.crover.domain2d
Interface ResidueColorScheme

All Known Implementing Classes:

ColorAnnotationsColorScheme, GPCRDB_ColorScheme, MonotonousColorScheme

public interface ResidueColorScheme

ColorSchemes are like this...

Method Summary

java.awt.Color	getBackgroundColor(char label, int position) Returns the background color for a residue.
java.awt.Color	getForegroundColor(char label, int position) Returns the foreground color for a residue.
java.lang.String	getInformation() Returns a descriptive text about this ColorScheme.
java.lang.String	getShortName() Returns a shortname for this ColorScheme.

Method Detail

getBackgroundColor

public java.awt.Color getBackgroundColor(char label,
                                         int position)

Returns the background color for a residue. The background color of a residue glyph is typically the color of the shape of residue glyph (disk, square, etc). The color depends on the label of the residue and on its position in the sequence (for display of properties).

getForegroundColor

public java.awt.Color getForegroundColor(char label,
                                         int position)

Returns the foreground color for a residue. The foreground color of a residue glyph is typically the color of the letter in the residue glyph. The color depends on the label of the residue and on its position in the sequence (for display of properties).

getShortName

public java.lang.String getShortName()

Returns a shortname for this ColorScheme. This string is typically less than 10 characters and can be presented to the user to let him choose between several colorscheme.

getInformation

public java.lang.String getInformation()

Returns a descriptive text about this ColorScheme. This text should explain the choice and attribution of the colors to the residues of the sequences.