diff options
| author | groditi <groditi@03d0b0b2-0e1a-0410-a411-fdb2f4bd65d7> | 2008-10-24 03:15:03 +0000 |
|---|---|---|
| committer | groditi <groditi@03d0b0b2-0e1a-0410-a411-fdb2f4bd65d7> | 2008-10-24 03:15:03 +0000 |
| commit | 7460b54490d1906c19559e37befa13fee7919227 (patch) | |
| tree | f48311c9e8a453e23355778be93fe59aaab84e05 /lib/Reaction/UI/ViewPort | |
| parent | 91140599186e2a589b4a4a9aa5d2d441fbdd0aee (diff) | |
| download | reaction-7460b54490d1906c19559e37befa13fee7919227.tar.gz reaction-7460b54490d1906c19559e37befa13fee7919227.zip | |
just a little more POD
Diffstat (limited to 'lib/Reaction/UI/ViewPort')
| -rw-r--r-- | lib/Reaction/UI/ViewPort/Collection.pm | 43 | ||||
| -rw-r--r-- | lib/Reaction/UI/ViewPort/Collection/Grid.pm | 4 | ||||
| -rw-r--r-- | lib/Reaction/UI/ViewPort/Image.pm | 2 |
3 files changed, 43 insertions, 6 deletions
diff --git a/lib/Reaction/UI/ViewPort/Collection.pm b/lib/Reaction/UI/ViewPort/Collection.pm index fef825a..05b2d6a 100644 --- a/lib/Reaction/UI/ViewPort/Collection.pm +++ b/lib/Reaction/UI/ViewPort/Collection.pm @@ -90,31 +90,62 @@ Reaction::UI::ViewPort::Collection =head1 DESCRIPTION -Creates, from an InterfaceModel::Collection, a list of viewports representing each -member of the collection. +Creates, from an InterfaceModel::Collection, a list of viewports representing +each member of the collection. =head1 ATTRIBUTES =head2 collection +Required read-only L<InterfaceModel::Collection|Reaction::InterfaceModel::Collection> +This is the original collection. + =head2 current_collection +Read-only, lazy-building +L<InterfaceModel::Collection|Reaction::InterfaceModel::Collection> +This is the collection that will be used to create C<members> and should be +altered to reflect any ordering, paging, etc. By default this is the +same thing as C<collection>. + =head2 member_args +A read-write HASH ref of additional parameters to pass to the C<member_class> +constructor as items are instantiated. + =head2 member_class +The class to use when instantiating items to represent the member items. + +See: L<Object|Reaction::UI::ViewPort::Object>, +L<Member|Reaction::UI::ViewPort::Grid::Member>, +L<Member::WithActions|Reaction::UI::ViewPort::Grid::Member::WithActions>, + =head1 INTERNAL METHODS -These methods, although stable, are subject to change without notice. These are meant -to be used only by developers. End users should refrain from using these methods to -avoid potential breakages. +These methods, although stable, are subject to change without notice. +Extend at your own risk, APIs may change in the future. =head2 BUILD -=head2 get_builder_for +Intercept a parameter with the key C<Member> amd store it in C<member_args> =head2 model +Returns the C<current_collection> + +=head2 _build_members + +Build individual viewports for each member of the collection, + +=head2 _build_member_args + +Defaults to an empty HASH ref. + +=head2 _build_member_class + +Defaults to L<Reaction::UI::ViewPort::Object> + =head1 AUTHORS See L<Reaction::Class> for authors. diff --git a/lib/Reaction/UI/ViewPort/Collection/Grid.pm b/lib/Reaction/UI/ViewPort/Collection/Grid.pm index 6d8e0a1..c9fc2f1 100644 --- a/lib/Reaction/UI/ViewPort/Collection/Grid.pm +++ b/lib/Reaction/UI/ViewPort/Collection/Grid.pm @@ -120,8 +120,12 @@ homogenous collection of Reaction::InterfaceModel::Objects as a grid. =head2 field_labels +=head2 _raw_field_labels + =head2 computed_field_order +=head2 member_action_count + =head1 INTERNAL METHODS These methods, although stable, are subject to change without notice. These are meant diff --git a/lib/Reaction/UI/ViewPort/Image.pm b/lib/Reaction/UI/ViewPort/Image.pm index 7c5cbd1..dd974e0 100644 --- a/lib/Reaction/UI/ViewPort/Image.pm +++ b/lib/Reaction/UI/ViewPort/Image.pm @@ -21,6 +21,8 @@ Reaction::UI::ViewPort::Image =head1 DESCRIPTION +A Viewport to display an image. + =head1 ATTRIBUTES =head2 uri |