widget documentation
[catagits/Reaction.git] / lib / Reaction / UI / Widget / Collection / Grid / Member.pm
1 package Reaction::UI::Widget::Collection::Grid::Member;
2
3 use Reaction::UI::WidgetClass;
4
5 use namespace::clean -except => [ qw(meta) ];
6 extends 'Reaction::UI::Widget::Object';
7
8 __PACKAGE__->meta->make_immutable;
9
10 1;
11
12 __END__;
13
14 =head1 NAME
15
16 Reaction::UI::Widget::Collection::Grid::Member - A member widget of the Grid widget
17
18 =head1 DESCRIPTION
19
20 A pure subclass of L<Reaction::UI::Widget::Object> representing a member
21 in a L<Reaction::UI::Widget::Collection::Grid>.
22
23 =head1 FRAGMENTS
24
25 This widget defines no additional fragments.
26
27 =head1 LAYOUT SETS
28
29 =head2 base
30
31   share/skin/base/layout/collection/grid/member.tt
32
33 The following layouts are provided:
34
35 =over 4
36
37 =item widget
38
39 Renders the C<field_list> fragment provided initially by L<Reaction::UI::Widget::Object>.
40
41 =item field
42
43 Renders the next C<field> fragment in the inheritance hierarchy.
44
45 =back
46
47 =head2 default
48
49   share/skin/default/layout/collection/grid/member.tt
50
51 This layout set extends the C<NEXT> skin in the inheritance hierarchy.
52
53 Like with L<Reaction::UI::Widget::Collection::Grid>, the C<default> layout set provides
54 a table based markup for the abstract view logic defined in the C<base> skin.
55
56 The following layouts are provided:
57
58 =over 4
59
60 =item widget
61
62 Renders the next C<widget> fragment surrounded by a C<tr> element.
63
64 =item field
65
66 Renders the next C<field> fragment surrounded by a C<td> element.
67
68 =back
69
70 =head1 SEE ALSO
71
72 =over 4
73
74 =item * L<Reaction::UI::Widget::Collection::Grid>
75
76 =item * L<Reaction::UI::Widget::Collection::Grid::Member::WithActions>
77
78 =back
79
80 =head1 AUTHORS
81
82 See L<Reaction::Class> for authors.
83
84 =head1 LICENSE
85
86 See L<Reaction::Class> for the license.
87
88 =cut