|
|||||||||||||||||||
30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover | |||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
IScript.java | - | - | - | - |
|
1 |
// Copyright 2004, 2005 The Apache Software Foundation
|
|
2 |
//
|
|
3 |
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4 |
// you may not use this file except in compliance with the License.
|
|
5 |
// You may obtain a copy of the License at
|
|
6 |
//
|
|
7 |
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8 |
//
|
|
9 |
// Unless required by applicable law or agreed to in writing, software
|
|
10 |
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12 |
// See the License for the specific language governing permissions and
|
|
13 |
// limitations under the License.
|
|
14 |
|
|
15 |
package org.apache.tapestry;
|
|
16 |
|
|
17 |
import java.util.Map;
|
|
18 |
|
|
19 |
import org.apache.hivemind.Resource;
|
|
20 |
|
|
21 |
/**
|
|
22 |
* An object that can convert a set of symbols into a collection of JavaScript statements.
|
|
23 |
*
|
|
24 |
* <p>IScript implementation must be threadsafe.
|
|
25 |
*
|
|
26 |
* @author Howard Lewis Ship
|
|
27 |
* @since 1.0.2
|
|
28 |
*
|
|
29 |
**/
|
|
30 |
|
|
31 |
public interface IScript |
|
32 |
{ |
|
33 |
/**
|
|
34 |
* Returns the location from which the script was loaded.
|
|
35 |
*
|
|
36 |
**/
|
|
37 |
|
|
38 |
public Resource getScriptResource();
|
|
39 |
|
|
40 |
/**
|
|
41 |
* Executes the script, which will read and modify the symbols {@link Map}. The
|
|
42 |
* script works with the {@link IScriptProcessor} to get the generated JavaScript
|
|
43 |
* included on the page.
|
|
44 |
*
|
|
45 |
* @param cycle the current request cycle
|
|
46 |
* @param processor an object that processes the results of the script, typically
|
|
47 |
* an instance of {@link org.apache.tapestry.html.Body}
|
|
48 |
* @param symbols Map of input symbols; execution of the script may modify the map,
|
|
49 |
* creating new output symbols
|
|
50 |
*
|
|
51 |
* @see TapestryUtils#getPageRenderSupport(IRequestCycle, Object)
|
|
52 |
*
|
|
53 |
*/
|
|
54 |
|
|
55 |
public void execute(IRequestCycle cycle, IScriptProcessor processor, Map symbols); |
|
56 |
} |
|