RbDe rbde-349 (20120127151154)

edu.mssm.crover.domain2d
Interface ResidueColorScheme

All Superinterfaces:
Serializable
All Known Implementing Classes:
ColorAnnotationsColorScheme, GPCRDB_ColorScheme, MonotonousColorScheme

public interface ResidueColorScheme
extends Serializable

Interface definining custom residue color schemes for RbDe.


Method Summary
 Color getBackgroundColor(char label, int position)
          Returns the background color for a residue.
 Color getForegroundColor(char label, int position)
          Returns the foreground color for a residue.
 String getInformation()
          Returns a descriptive text about this ColorScheme.
 String getShortName()
          Returns a short name for this ColorScheme.
 

Method Detail

getBackgroundColor

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).

Parameters:
label - the character code for the residue
position - The position of the residue
Returns:
The background color of the resiude

getForegroundColor

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).

Parameters:
label - the character code for the residue
position - The position of the residue
Returns:
The foreground color of the resiude

getShortName

String getShortName()
Returns a short name for this ColorScheme. This string is typically less than 10 characters and can be presented to the user to let him choose between several color schemes.

Returns:
the name of the color scheme

getInformation

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.

Returns:
additional information about this color scheme

RbDe rbde-349 (20120127151154)

Copyright © 2003-2012 Institute for Computational Biomedicine, All Rights Reserved.