webgui/lib/WebGUI/Form/integer.pm
2005-07-27 18:03:32 +00:00

129 lines
2.8 KiB
Perl

package WebGUI::Form::integer;
=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::text';
use WebGUI::International;
use WebGUI::Session;
use WebGUI::Style;
=head1 NAME
Package WebGUI::Form::integer
=head1 DESCRIPTION
Creates an input field that accepts positive and negative integer.
=head1 SEE ALSO
This is a subclass of WebGUI::Form::text.
=head1 METHODS
The following methods are specifically available from this class. Check the superclass for additional methods.
=cut
#-------------------------------------------------------------------
=head2 definition ( [ additionalTerms ] )
See the superclass for additional details.
=head3 additionalTerms
The following additional parameters have been added via this sub class.
=head4 maxlength
Defaults to 11. Determines the maximum number of characters allowed in this field.
=head4 defaultValue
Defaults to 0. Used if no value is specified.
=head4 size
Defaults to 11. The number of characters that will be displayed at once in this field. Usually no need to override the default.
=cut
sub definition {
my $class = shift;
my $definition = shift || [];
push(@{$definition}, {
maxlength=>{
defaultValue=> 11
},
defaultValue=>{
defaultValue=>0
},
size=>{
defaultValue=>11
}
});
return $class->SUPER::definition($definition);
}
#-------------------------------------------------------------------
=head2 getName ()
Returns the human readable name or type of this form control.
=cut
sub getName {
return WebGUI::International::get("482","WebGUI");
}
#-------------------------------------------------------------------
=head2 getValueFromPost ( )
Returns the integer from the form post, or returns 0 if the post result is invalid.
=cut
sub getValueFromPost {
my $self = shift;
my $value = $session{cgi}->param($self->{name});
if ($value =~ /^[\d\-]+$/) {
return $value;
}
return 0;
}
#-------------------------------------------------------------------
=head2 toHtml ( )
Renders an integer field.
=cut
sub toHtml {
my $self = shift;
WebGUI::Style::setScript($session{config}{extrasURL}.'/inputCheck.js',{ type=>'text/javascript' });
$self->{extras} .= ' onkeyup="doInputCheck(this.form.'.$self->{name}.',\'0123456789-\')"';
return $self->SUPER::toHtml;
}
1;