webgui/lib/WebGUI/Form/SelectBox.pm
2005-12-04 15:56:59 +00:00

114 lines
2.6 KiB
Perl

package WebGUI::Form::SelectBox;
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2005 Plain Black Corporation.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict;
use base 'WebGUI::Form::List';
use WebGUI::International;
use WebGUI::Session;
=head1 NAME
Package WebGUI::Form::SelectBox
=head1 DESCRIPTION
Creates a select list, aka dropdown list form control with single select.
=head1 SEE ALSO
This is a subclass of WebGUI::Form::List.
=head1 METHODS
The following methods are specifically available from this class. Check the superclass for additional methods.
=cut
##-------------------------------------------------------------------
=head2 correctValues ( )
Override method from master class since SelectBox only support a single value
=cut
sub correctValues { }
#-------------------------------------------------------------------
=head2 definition ( [ additionalTerms ] )
See the super class for additional details.
=head3 additionalTerms
The following additional parameters have been added via this sub class.
=head4 size
The number of characters tall this list should be. Defaults to '1'.
=head4 profileEnabled
Flag that tells the User Profile system that this is a valid form element in a User Profile
=cut
sub definition {
my $class = shift;
my $definition = shift || [];
push(@{$definition}, {
formName=>{
defaultValue=>WebGUI::International::get("487","WebGUI"),
},
size=>{
defaultValue=>1,
},
profileEnabled=>{
defaultValue=>1,
},
});
return $class->SUPER::definition($definition);
}
#-------------------------------------------------------------------
=head2 toHtml ( )
Renders a select list form control.
=cut
sub toHtml {
my $self = shift;
my $output = '<select name="'.$self->{name}.'" size="'.$self->{size}.'" id="'.$self->{id}.'" '.$self->{extras}.'>';
my %options;
tie %options, 'Tie::IxHash';
%options = $self->orderedHash;
my ($value) = $self->getValues();
foreach my $key (keys %options) {
$output .= '<option value="'.$key.'"';
if ($value eq $key) {
$output .= ' selected="selected"';
}
$output .= '>'.${$self->{options}}{$key}.'</option>';
}
$output .= '</select>'."\n";
return $output;
}
1;