lib/CXGN/Page/Form/RadioList.pm

   1 =head1 NAME
   2
   3 CXGN::Page::Form::RadioList;
   4
   5 =head1 DESCRIPTION
   6
   7 Implements a static (non-editable) list of radio buttons on a static form. For more information, see L<CXGN::Page::Form>.
   8
   9 =head1 AUTHOR(S)
  10
  11 Evan Herbst
  12
  13 =cut
  14
  15 use strict;
  16 use CXGN::Page::Form::ElementI;
  17
  18 package CXGN::Page::Form::RadioList;
  19
  20 use base qw/ CXGN::Page::Form::ElementI /;
  21
  22 =head2 new
  23
  24  Usage:        don't currently make use of the 'id' parameter, unlike other form fields
  25  Desc:
  26  Ret:
  27  Args:         a hashref with the following keys:
  28                display_name  (name of the field for display purposes)
  29                field_name (name of the variable)
  30                                         id_prefix (a string to be prepended to the choices to get radio-button element IDs)
  31                                         choices (a listref of values for the buttons to be shown)
  32                                         labels (a listref of labels for the buttons to be shown)
  33                contents (the current value of the field; can be empty)
  34                object (the object this field maps to)
  35                getter (the getter function for this field in the object)
  36                setter (the setter function for this field in the object)
  37  Side Effects:
  38  Example:
  39
  40 =cut
  41
  42 sub new
  43 {
  44         my $class = shift;
  45         my %params = @_;
  46         my $self = $class->SUPER::new(%params);
  47         #store the parameters that aren't handled by our superclass
  48         foreach my $param (qw(choices labels id_prefix))
  49         {
  50                 my $set_func = "set_$param";
  51                 $self->$set_func($params{$param});
  52         }
  53         return $self;
  54 }
  55
  56 =head2 render
  57
  58  Usage:
  59  Desc:
  60  Ret:
  61  Args:
  62  Side Effects:
  63  Example:
  64
  65 =cut
  66
  67 sub render
  68 {
  69         my $self = shift;
  70         my $html = "<ul>";
  71         for(my $i = 0; $i < scalar($self->get_choice_array()); $i++)
  72         {
  73                 if($self->get_contents() eq $self->get_choice($i))
  74                 {
  75                         $html .= "<li> &raquo;&nbsp;" . $self->get_label($i) . "&nbsp;&laquo; </li>";
  76                 }
  77                 else
  78                 {
  79                         $html .= "<li>" . $self->get_label($i) . "</li>";
  80                 }
  81         }
  82         return $html . "</ul>";
  83 }
  84
  85 =head2 get_id_prefix
  86
  87 =cut
  88
  89 sub get_id_prefix
  90 {
  91         my $self = shift;
  92         return $self->{id_prefix};
  93 }
  94
  95 =head2 get_choice
  96
  97 Args: choice index
  98
  99 =cut
 100
 101 sub get_choice
 102 {
 103         my ($self, $i) = @_;
 104         return $self->{choices}->[$i];
 105 }
 106
 107 =head2 get_choice_array
 108
 109 Ret: array (not arrayref) of choices
 110
 111 =cut
 112
 113 sub get_choice_array
 114 {
 115         my $self = shift;
 116         return @{$self->{choices}};
 117 }
 118
 119 =head2 get_label
 120
 121 Args: label index
 122
 123 =cut
 124
 125 sub get_label
 126 {
 127         my ($self, $i) = @_;
 128         return $self->{labels}->[$i];
 129 }
 130
 131 =head2 set_id_prefix
 132
 133 Args: string
 134
 135 =cut
 136
 137 sub set_id_prefix
 138 {
 139         my ($self, $prefix) = @_;
 140         $self->{id_prefix} = $prefix;
 141 }
 142
 143 =head2 set_choices
 144
 145 Args: arrayref of choices
 146
 147 =cut
 148
 149 sub set_choices
 150 {
 151         my ($self, $choices) = @_;
 152         $self->{choices} = $choices;
 153 }
 154
 155 =head2 set_labels
 156
 157 Args: arrayref of labels
 158
 159 =cut
 160
 161 sub set_labels
 162 {
 163         my ($self, $labels) = @_;
 164         $self->{labels} = $labels;
 165 }
 166
 167 return 1;