File Coverage

lib/HTML/Object/DOM/Element/TableCaption.pm
Criterion Covered Total %
statement 27 27 100.0
branch 3 4 75.0
condition 2 3 66.6
subroutine 9 9 100.0
pod 1 1 100.0
total 42 44 95.4


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## HTML Object - ~/lib/HTML/Object/DOM/Element/TableCaption.pm
3             ## Version v0.2.0
4             ## Copyright(c) 2022 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2022/01/06
7             ## Modified 2022/09/18
8             ## All rights reserved
9             ##
10             ##
11             ## This program is free software; you can redistribute it and/or modify it
12             ## under the same terms as Perl itself.
13             ##----------------------------------------------------------------------------
14             package HTML::Object::DOM::Element::TableCaption;
15             BEGIN
16             {
17 2     2   2094 use strict;
  2         4  
  2         62  
18 2     2   10 use warnings;
  2         4  
  2         60  
19 2     2   11 use parent qw( HTML::Object::DOM::Element );
  2         4  
  2         10  
20 2     2   150 use vars qw( $VERSION );
  2         3  
  2         95  
21 2     2   11 use HTML::Object::DOM::Element::Shared qw( :tablecaption );
  2         5  
  2         205  
22 2     2   47 our $VERSION = 'v0.2.0';
23             };
24              
25 2     2   12 use strict;
  2         4  
  2         49  
26 2     2   9 use warnings;
  2         4  
  2         257  
27              
28             sub init
29             {
30 2     2 1 43221 my $self = shift( @_ );
31 2         82 $self->{_init_strict_use_sub} = 1;
32 2 50       28 $self->SUPER::init( @_ ) || return( $self->pass_error );
33 2 100 66     16 $self->{tag} = 'caption' if( !defined( $self->{tag} ) || !CORE::length( "$self->{tag}" ) );
34 2         25 return( $self );
35             }
36              
37             # Note: deprecated property align is inherited
38              
39             1;
40             # NOTE: POD
41             __END__
42              
43             =encoding utf-8
44              
45             =head1 NAME
46              
47             HTML::Object::DOM::Element::TableCaption - HTML Object DOM TableCaption Class
48              
49             =head1 SYNOPSIS
50              
51             use HTML::Object::DOM::Element::TableCaption;
52             my $caption = HTML::Object::DOM::Element::TableCaption->new ||
53             die( HTML::Object::DOM::Element::TableCaption->error, "\n" );
54              
55             =head1 VERSION
56              
57             v0.2.0
58              
59             =head1 DESCRIPTION
60              
61             This interface special properties (beyond the regular L<HTML::Object::DOM::Element> interface it also has available to it by inheritance) for manipulating table C<caption> elements.
62              
63             =head1 INHERITANCE
64              
65             +-----------------------+ +---------------------------+ +-------------------------+ +----------------------------+ +------------------------------------------+
66             | HTML::Object::Element | --> | HTML::Object::EventTarget | --> | HTML::Object::DOM::Node | --> | HTML::Object::DOM::Element | --> | HTML::Object::DOM::Element::TableCaption |
67             +-----------------------+ +---------------------------+ +-------------------------+ +----------------------------+ +------------------------------------------+
68              
69             =head1 PROPERTIES
70              
71             Inherits properties from its parent L<HTML::Object::DOM::Element>
72              
73             =head1 METHODS
74              
75             Inherits methods from its parent L<HTML::Object::DOM::Element>
76              
77             =head1 EXAMPLE
78              
79             <table>
80             <caption>Example Caption</caption>
81             <tr>
82             <th>Login</th>
83             <th>Email</th>
84             </tr>
85             <tr>
86             <td>user1</td>
87             <td>user1@sample.com</td>
88             </tr>
89             <tr>
90             <td>user2</td>
91             <td>user2@sample.com</td>
92             </tr>
93             </table>
94              
95             =head1 DEPRECATED PROPERTIES
96              
97             =head2 align
98              
99             Is a string which represents an enumerated attribute indicating alignment of the caption with respect to the table. It may have one of the following values:
100              
101             =over 4
102              
103             =item left
104              
105             The caption is displayed to the left of the table.
106              
107             =item top
108              
109             The caption is displayed above the table.
110              
111             =item right
112              
113             The caption is displayed to the right of the table.
114              
115             =item bottom
116              
117             The caption is displayed below the table.
118              
119             =back
120              
121             See also L<Mozilla documentation|https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableCaptionElement/align>
122              
123             =head1 AUTHOR
124              
125             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
126              
127             =head1 SEE ALSO
128              
129             L<Mozilla documentation|https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableCaptionElement>, L<Mozilla documentation on tablecaption element|https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tablecaption>, L<Specifications|https://html.spec.whatwg.org/multipage/tables.html#htmltablecaptionelement>
130              
131             =head1 COPYRIGHT & LICENSE
132              
133             Copyright(c) 2022 DEGUEST Pte. Ltd.
134              
135             All rights reserved
136              
137             This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
138              
139             =cut