RbDe rbde-349 (20120127151154)

edu.mssm.crover.domain2d
Interface ResidueGlyphRenderingAttributes

All Known Subinterfaces:
ResidueModelFactory
All Known Implementing Classes:
BasicResidueGlyphRenderingAttributes, SharedResidueModelFactory, UniqueResidueModelFactory

public interface ResidueGlyphRenderingAttributes

To set and get the ResidueGlyph rendering attributes. Oddly, this is implemented by ResidueModelFactory implementations, simply because we already pass an instance to the SSR engines.


Method Summary
 boolean getDefaultResidueGlyphOutline()
          Get the suggested default outline attribute.
 int getDefaultResidueShape()
          Get the shape of residues that are not hyperlinked.
 int getLinkedResidueShape()
          Get the shape of residues that are hyperlinked.
 int getStartResidueNumbering()
          Get the start number for residues.
 void setDefaultResidueGlyphOutline(boolean outline)
          Sets the outline attribute for future instances of ResidueGlyph.
 void setDefaultResidueShape(int shape)
          Sets the shape of linked residues.
 void setLinkedResidueShape(int shape)
          Sets the shape of linked residues.
 void setStartResidueNumbering(int startNumber)
          Set the start number for resiudes.
 

Method Detail

setDefaultResidueGlyphOutline

void setDefaultResidueGlyphOutline(boolean outline)
Sets the outline attribute for future instances of ResidueGlyph.

Parameters:
outline - an outline display is suggested when true.
See Also:
for usage.

getDefaultResidueGlyphOutline

boolean getDefaultResidueGlyphOutline()
Get the suggested default outline attribute.

Returns:
true if the glyphs should be outlined

setLinkedResidueShape

void setLinkedResidueShape(int shape)
Sets the shape of linked residues. Hyperlinked residues will have this shape by default. When not set, linked residues have the same shape that non linked residues. Invalid shapes are silently ignored.

Parameters:
shape - type of the shape, as defined in ResidueGlyph
See Also:
ResidueGlyph.CIRCLE_SHAPE, ResidueGlyph.RECT_SHAPE, ResidueGlyph.OCTAGONAL_SHAPE

setDefaultResidueShape

void setDefaultResidueShape(int shape)
Sets the shape of linked residues. Residues will have this shape by default, unless hyperlinked. When not set, the shape of residues defaults to circles. Invalid shapes are silently ignored.

Parameters:
shape - Type of the shape, as defined in ResidueGlyph
See Also:
ResidueGlyph.CIRCLE_SHAPE, ResidueGlyph.RECT_SHAPE, ResidueGlyph.OCTAGONAL_SHAPE

getLinkedResidueShape

int getLinkedResidueShape()
Get the shape of residues that are hyperlinked.

Returns:
Shape for the residues.
See Also:
for shape definitions.

getDefaultResidueShape

int getDefaultResidueShape()
Get the shape of residues that are not hyperlinked.

Returns:
Shape for the residues.

setStartResidueNumbering

void setStartResidueNumbering(int startNumber)
Set the start number for resiudes.

Parameters:
startNumber - The number to use as a starting point

getStartResidueNumbering

int getStartResidueNumbering()
Get the start number for residues.

Returns:
The number used as a starting point

RbDe rbde-349 (20120127151154)

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