added/updated documentation

This commit is contained in:
Doug Bell 2010-10-14 16:13:24 -05:00
parent b80c2bed22
commit 5116fcaa8a
2 changed files with 116 additions and 70 deletions

View file

@ -4,18 +4,64 @@ use Moose;
use MooseX::Storage;
use WebGUI::FormBuilder::Tab;
=head1 NAME
WebGUI::FormBuilder::Tabset - A set of tabs
=head1 SYNOPSIS
my $tabset = WebGUI::FormBuilder::Tabset->new( $session, name => "properties" );
my $tab = $tabset->addTab( WebGUI::FormBuilder::Tab->new( $session, name => "normal" ) );
# Using FormBuilder
my $f = WebGUI::FormBuilder->new( $session );
$f->addTabset( name => "properties" );
$f->addTab( name => "normal", tabset => "properties" );
=head1 DESCRIPTION
A tabset holds tabs. It does nothing else. Tabs can in turn hold fields, fieldsets,
or other tabsets.
Tabs are displayed using YUI TabView.
=head1 SEE ALSO
WebGUI::FormBuilder
WebGUI::FormBuilder::Tab
=head1 ATTRIBUTES
=head2 name
A name string. Required.
=cut
has 'name' => (
is => 'ro',
isa => 'Str',
required => 1,
);
=head2 tabs
The array of tabs this tabset contains.
=cut
has 'tabs' => (
is => 'rw',
isa => 'ArrayRef',
default => sub { [] },
);
=head2 session
The WebGUI::Session object. Required.
=cut
has 'session' => (
is => 'ro',
isa => 'WebGUI::Session',
@ -33,14 +79,6 @@ with 'WebGUI::FormBuilder::Role::HasObjects';
Create a new Tabset object. C<properties> is a list of name => value pairs
=over 4
=item name
The name of the tabset. Required.
=back
=cut
sub BUILDARGS {