Added to perldoc instructions about the use of the environment variables.
[cxgn-corelibs.git] / lib / CXGN / Cview / Label / SequencedBACLabel.pm
blob48e1980e0ba3efbbb6a3432e3f28b403f18eb334
2 =head1 NAME
4 CXGN::Cview::Label::SequencedBACLabel - a class for drawing sequence BAC labels.
6 =head1 DESCRIPTION
8 The sequenced BAC labels should always be rendered in yellow. Therefore, this class overrides the get_text_color() and the get_line_color() methods of the CXGN::Cview::Label class to always returns yellow. The setter has no effect in this class. This class is used by the CXGN::Cview::Marker::SequencedBAC class.
10 =head1 AUTHOR(S)
12 Lukas Mueller (lam87@cornell.edu)
14 =head1 FUNCTIONS
16 This class implements the following functions:
18 =cut
20 use strict;
22 use CXGN::Cview::Label;
24 package CXGN::Cview::Label::SequencedBACLabel;
26 use base qw / CXGN::Cview::Label /;
29 =head2 function new()
31 Synopsis: constructor
32 Arguments: same as CXGN::Cview::Label class.
33 Returns:
34 Side effects:
35 Description:
37 =cut
39 sub new {
40 my $class = shift;
41 my $self = $class->SUPER::new(@_);
42 return $self;
45 =head2 function get_text_color()
47 Synopsis: overridden to always return yellow.
48 Arguments:
49 Returns:
50 Side effects:
51 Description:
53 =cut
55 sub get_text_color {
56 my $self = shift;
57 return (200, 200, 80);
60 =head2 function get_line_color()
62 Synopsis: overridden to always return yellow.
63 Arguments:
64 Returns:
65 Side effects:
66 Description:
68 =cut
70 sub get_line_color {
71 my $self = shift;
72 return (200, 200, 80);