[Bio] / WebApplication / WebComponent.pm Repository:
ViewVC logotype

Annotation of /WebApplication/WebComponent.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (view) (download) (as text)

1 : paczian 1.1 package WebComponent;
2 :    
3 :     # WebComponent - abstract web component class
4 :    
5 : paarmann 1.2 # $Id: WebComponent.pm,v 1.1 2007/04/27 16:02:14 paczian Exp $
6 : paczian 1.1
7 :     use strict;
8 :     use warnings;
9 :    
10 :    
11 :     =pod
12 :    
13 :     =head1 NAME
14 :    
15 :     WebComponent - abstract web component class
16 :    
17 :     =head1 DESCRIPTION
18 :    
19 :     This module is the abstract WebComponent class used by the web application
20 :     framework. A web component is a reusable page element inherited from this
21 :     class. Each component is assigned an unique id (to support javascript
22 :     operations on the components).
23 :    
24 :     Using a web component is done by requesting the component from the application,
25 :     then setting parameters as supported by the specific component and finally
26 :     returning the html output of the component.
27 :    
28 :     =head1 METHODS
29 :    
30 :     =over 4
31 :    
32 :     =item * B<new> (I<application>, I<id>)
33 :    
34 :     Creates a new instance of the WebComponent object. The constructor requires
35 :     a reference to the web application object and an (unique) id. Unique ids
36 :     are used to manipulate html elements by javascript.
37 :    
38 :     =cut
39 :    
40 :     sub new {
41 :     my ($class, $application, $id) = @_;
42 :    
43 :     # check application
44 :     unless (ref $application and $application->isa("WebApplication")) {
45 : paarmann 1.2 die "Invalid application in __PACKAGE__ new.";
46 : paczian 1.1 }
47 :    
48 :     $id = '' unless (defined $id);
49 :    
50 :     my $self = { 'application' => $application,
51 :     'id' => $id,
52 :     'css' => undef,
53 :     };
54 :     bless $self, $class;
55 :    
56 :     return $self;
57 :     }
58 :    
59 :    
60 :     =pod
61 :    
62 :     =item * B<application> ()
63 :    
64 :     Returns the reference to the application object
65 :    
66 :     =cut
67 :    
68 :     sub application {
69 :     return $_[0]->{'application'};
70 :     }
71 :    
72 :    
73 :     =pod
74 :    
75 :     =item * B<id> ()
76 :    
77 :     Returns the numerical id of the web component
78 :    
79 :     =cut
80 :    
81 :     sub id {
82 :     return $_[0]->{'id'};
83 :     }
84 :    
85 :    
86 :     =pod
87 :    
88 :     =item * B<get_trigger> (I<action_name>)
89 :    
90 :     Returns a unique cgi action param based on the I<action_name>.
91 :    
92 :     =cut
93 :    
94 :     sub get_trigger {
95 :     return 'wac_'.$_[0]->id.'_'.$_[1];
96 :     }
97 :    
98 :     =pod
99 :    
100 :     =item * B<require_javascript> ()
101 :    
102 :     Returns a reference to an array of javascript files to include into the
103 :     output page. By default the method returns the reference to an empty
104 :     array. Overload in inherited web components as needed.
105 :    
106 :     =cut
107 :    
108 :     sub require_javascript {
109 :     return [ ];
110 :     }
111 :    
112 :    
113 :     =pod
114 :    
115 :     =item * B<require_css> (I<css_file>)
116 :    
117 :     Returns the name of the css file to include into the the html of the web component.
118 :     If the optional parameter I<css_file> is given, the component will require that
119 :     css file instead of the default one.
120 :    
121 :     =cut
122 :    
123 :     sub require_css {
124 :     if ($_[1]) {
125 :     $_[0]->{'css'} = $_[1];
126 :     }
127 :     return $_[0]->{'css'};
128 :     }
129 :    
130 :    
131 :     =pod
132 :    
133 :     =item * B<output> ()
134 :    
135 :     Returns the html of the web component
136 :    
137 :     =cut
138 :    
139 :     sub output {
140 :     die "Abstract method 'output' must be implemented in __PACKAGE__.\n";
141 :     }
142 :    
143 :    
144 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3