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

Annotation of /WebApplication/WebComponent.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3