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

Annotation of /WebApplication/WebComponent.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : paczian 1.1 package WebComponent;
2 :    
3 :     # WebComponent - abstract web component class
4 :    
5 : paczian 1.6 # $Id: WebComponent.pm,v 1.5 2009/02/05 07:30:55 parrello Exp $
6 : paczian 1.1
7 :     use strict;
8 :     use warnings;
9 : parrello 1.3 use FIG_Config;
10 : paczian 1.1
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 : parrello 1.4 my $sv_url = "$FIG_Config::cgi_url/seedviewer.cgi";
50 :     if (FIGRules::nmpdr_mode($application->cgi) && $FIG_Config::linkinSV) {
51 :     $sv_url = $FIG_Config::linkinSV;
52 :     }
53 : paczian 1.1 my $self = { 'application' => $application,
54 :     'id' => $id,
55 :     'css' => undef,
56 : parrello 1.4 'svURL' => $sv_url,
57 : paczian 1.6 'sigleton' => 0,
58 : paczian 1.1 };
59 :     bless $self, $class;
60 :    
61 :     return $self;
62 :     }
63 :    
64 :    
65 :     =pod
66 :    
67 :     =item * B<application> ()
68 :    
69 :     Returns the reference to the application object
70 :    
71 :     =cut
72 :    
73 :     sub application {
74 :     return $_[0]->{'application'};
75 :     }
76 :    
77 :    
78 :     =pod
79 :    
80 : parrello 1.3 =item * B<svURL> ()
81 :    
82 :     Returns the Seed Viewer URL
83 :    
84 :     =cut
85 :    
86 :     sub svURL {
87 :     return $_[0]->{svURL};
88 :     }
89 :    
90 :     =pod
91 :    
92 : paczian 1.1 =item * B<id> ()
93 :    
94 :     Returns the numerical id of the web component
95 :    
96 :     =cut
97 :    
98 :     sub id {
99 :     return $_[0]->{'id'};
100 :     }
101 :    
102 :    
103 :     =pod
104 :    
105 :     =item * B<get_trigger> (I<action_name>)
106 :    
107 :     Returns a unique cgi action param based on the I<action_name>.
108 :    
109 :     =cut
110 :    
111 :     sub get_trigger {
112 :     return 'wac_'.$_[0]->id.'_'.$_[1];
113 :     }
114 :    
115 :     =pod
116 :    
117 :     =item * B<require_javascript> ()
118 :    
119 :     Returns a reference to an array of javascript files to include into the
120 :     output page. By default the method returns the reference to an empty
121 :     array. Overload in inherited web components as needed.
122 :    
123 :     =cut
124 :    
125 :     sub require_javascript {
126 :     return [ ];
127 :     }
128 :    
129 :    
130 :     =pod
131 :    
132 :     =item * B<require_css> (I<css_file>)
133 :    
134 :     Returns the name of the css file to include into the the html of the web component.
135 :     If the optional parameter I<css_file> is given, the component will require that
136 :     css file instead of the default one.
137 :    
138 :     =cut
139 :    
140 :     sub require_css {
141 :     if ($_[1]) {
142 :     $_[0]->{'css'} = $_[1];
143 :     }
144 :     return $_[0]->{'css'};
145 :     }
146 :    
147 :    
148 :     =pod
149 :    
150 :     =item * B<output> ()
151 :    
152 :     Returns the html of the web component
153 :    
154 :     =cut
155 :    
156 :     sub output {
157 :     die "Abstract method 'output' must be implemented in __PACKAGE__.\n";
158 :     }
159 :    
160 : parrello 1.5 =head3 JavaCall
161 :    
162 :     my $string = $comp->JavaCall($name => @parms);
163 :    
164 :     Format a call to a java function. The parameters will all be converted to
165 :     string literals and assembled with the method name.
166 :    
167 :     =over 4
168 :    
169 :     =item name
170 :    
171 :     Name of the Java method to call.
172 :    
173 :     =item parms
174 :    
175 :     A list of strings. The strings will be converted to Javascript string literals
176 :     and specified as parameters on the method call.
177 :    
178 :     =item RETURN
179 :    
180 :     Returns a string that can be used as an event parameter to call the specified
181 :     Javascript method passing in the specified literal values.
182 :    
183 :     =back
184 :    
185 :     =cut
186 :    
187 :     sub JavaCall {
188 :     # Get the parameters.
189 :     my ($self, $name, @parms) = @_;
190 :     # Quote the strings.
191 :     my @literals;
192 :     for my $parm (@parms) {
193 :     $parm =~ s/\n/\\n/g;
194 :     $parm =~ s/'/\\'/g;
195 :     push @literals, "'$parm'";
196 :     }
197 :     # Assemble the call.
198 :     my $retVal = "$name(" . join(", ", @literals) . ")";
199 :     # Return the result.
200 :     return $retVal;
201 :     }
202 : paczian 1.1
203 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3