Bio::Graphics::Glyph::text_in_box - The "text in box" glyph

Bio-Graphics documentation Contained in the Bio-Graphics distribution.

Index

Code Index:

NAME

Top

Bio::Graphics::Glyph::text_in_box - The "text in box" glyph

SYNOPSIS

Top

  See L<Bio::Graphics::Panel> and L<Bio::Graphics::Glyph>.

DESCRIPTION

Top

This glyph draws the specified text in a rectangular box.

OPTIONS

In addition to the common options, the following glyph-specific options are recognized:

  Option      Description                  Default
  ------      -----------                  -------

  -text       The text to draw in the box    3'

  -text_pad   The number of pixels to offset 3
              the box

  -text_bgcolor                             none
              The background color of the box

BUGS

Top

Please report them.

SEE ALSO

Top

Bio::Graphics::Panel, Bio::Graphics::Glyph, Bio::Graphics::Glyph::arrow, Bio::Graphics::Glyph::cds, Bio::Graphics::Glyph::crossbox, Bio::Graphics::Glyph::diamond, Bio::Graphics::Glyph::dna, Bio::Graphics::Glyph::dot, Bio::Graphics::Glyph::ellipse, Bio::Graphics::Glyph::extending_arrow, Bio::Graphics::Glyph::generic, Bio::Graphics::Glyph::graded_segments, Bio::Graphics::Glyph::heterogeneous_segments, Bio::Graphics::Glyph::line, Bio::Graphics::Glyph::pinsertion, Bio::Graphics::Glyph::primers, Bio::Graphics::Glyph::rndrect, Bio::Graphics::Glyph::segments, Bio::Graphics::Glyph::ruler_arrow, Bio::Graphics::Glyph::toomany, Bio::Graphics::Glyph::transcript, Bio::Graphics::Glyph::transcript2, Bio::Graphics::Glyph::translation, Bio::Graphics::Glyph::triangle, Bio::DB::GFF, Bio::SeqI, Bio::SeqFeatureI, Bio::Das, GD

AUTHOR

Top

Vsevolod (Simon) Ilyushchenko <simonf@cshl.edu>.

Copyright (c) 2004 Cold Spring Harbor Laboratory

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See DISCLAIMER.txt for disclaimers of warranty.

Bio-Graphics documentation Contained in the Bio-Graphics distribution. 
package Bio::Graphics::Glyph::text_in_box;

use strict;
use base qw(Bio::Graphics::Glyph::generic);

sub default_text
{
  return "3'";  
}

sub default_text_pad
{
  return 3;  
}

sub draw_component {
  my $self = shift;
  my $gd = shift;
  my ($x1,$y1,$x2,$y2) = $self->calculate_boundaries(@_);
  
  my $fg = $self->fgcolor;
  
  my $font = $self->option('labelfont') || $self->font;
  
  my $text = defined $self->option('text') ? $self->option('text') : $self->default_text();
  my $text_pad = defined $self->option('text_pad') ? $self->option('text_pad') : $self->default_text_pad();
  
  my $width = $font->width * length $text;
  my $height = $font->height;

  my $midY = ($y2+$y1) / 2;

  my $poly_pkg = $self->polygon_package;
  
  my $polygon   = $poly_pkg->new();
  $polygon->addPt($x1,$midY-$height/2-$text_pad);
  $polygon->addPt($x1+$width+2*$text_pad,$midY-$height/2-$text_pad);
  $polygon->addPt($x1+$width+2*$text_pad,$midY+$height/2+$text_pad);
  $polygon->addPt($x1, $midY+$height/2+$text_pad);

  if (defined (my $bgcolor = $self->option('text_bgcolor')))
  {
    $gd->filledPolygon($polygon,$self->factory->translate_color($bgcolor));
  }

  $gd->polygon($polygon,$fg);
      
  $gd->string($font, $x1+$text_pad, $midY-$height/2, $text, $self->fontcolor);
}


1;

__END__