156 lines
3.8 KiB
Perl
156 lines
3.8 KiB
Perl
package WebGUI::Form::Combo;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2012 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::SelectBox';
|
|
use WebGUI::Form::Text;
|
|
use WebGUI::International;
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Form::Combo
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Creates a select list merged with a text box form control. The text box form control can
|
|
be used to enter data apart from the list options or to add new options to the list of
|
|
available options. The last function is dependent on the caller of the Form field
|
|
appending the new value to the list of options.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
This is a subclass of WebGUI::Form::SelectBox.
|
|
|
|
=head1 METHODS
|
|
|
|
The following methods are specifically available from this class. Check the superclass for additional methods.
|
|
|
|
=cut
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 definition ( session, [ additionalTerms ] )
|
|
|
|
Add another field so we can provide extras to the text area vs the selectBox
|
|
|
|
=cut
|
|
|
|
sub definition {
|
|
my $class = shift;
|
|
my $session = shift;
|
|
my $definition = shift || [];
|
|
push(@{$definition}, {
|
|
textExtras=>{
|
|
defaultValue=>undef
|
|
},
|
|
});
|
|
return $class->SUPER::definition($session, $definition);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getDatabaseFieldType ( )
|
|
|
|
Returns "TEXT".
|
|
|
|
=cut
|
|
|
|
sub getDatabaseFieldType {
|
|
return "TEXT";
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getName ( session )
|
|
|
|
Returns the human readable name of this control.
|
|
|
|
=cut
|
|
|
|
sub getName {
|
|
my ($self, $session) = @_;
|
|
return WebGUI::International->new($session, 'WebGUI')->get('combobox');
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getValue ( [ value ] )
|
|
|
|
Returns an array or a carriage return ("\n") separated scalar depending
|
|
upon whether you're returning the values into an array or a scalar. If
|
|
any data is in the Text form, it is returned before a selected value from
|
|
the list.
|
|
|
|
=head3 value
|
|
|
|
Optional values to process, instead of POST input.
|
|
|
|
=cut
|
|
|
|
sub getValue {
|
|
my $self = shift;
|
|
|
|
if (@_) {
|
|
return $self->SUPER::getValue(@_);
|
|
}
|
|
elsif ($self->session->form->param($self->get("name")."_new")) {
|
|
my $formValue = $self->session->form->param($self->get("name")."_new");
|
|
$formValue =~ tr/\r\n//d;
|
|
return $formValue;
|
|
}
|
|
return $self->SUPER::getValue(@_);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 isDynamicCompatible ( )
|
|
|
|
A class method that returns a boolean indicating whether this control is compatible with the DynamicField control.
|
|
|
|
=cut
|
|
|
|
sub isDynamicCompatible {
|
|
return 0;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 toHtml ( )
|
|
|
|
Renders a combo box form control.
|
|
|
|
=cut
|
|
|
|
sub toHtml {
|
|
my $self = shift;
|
|
my $i18n = WebGUI::International->new($self->session);
|
|
my $options = $self->getOptions;
|
|
$options->{''} = '['.$i18n->get(582).']';
|
|
$options->{_new_} = $i18n->get(581).'->';
|
|
$self->set('options', $options);
|
|
return $self->SUPER::toHtml
|
|
.WebGUI::Form::Text->new($self->session,
|
|
size=>$self->session->setting->get("textBoxSize")-5,
|
|
name=>$self->get("name")."_new",
|
|
id=>$self->get('id')."_new",
|
|
extras=>$self->get('textExtras'),
|
|
)->toHtml;
|
|
}
|
|
|
|
|
|
|
|
1;
|
|
|