Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
PageRenderSupport |
|
| 1.0;1 |
1 | // Copyright 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 | /** | |
18 | * Extends {@link org.apache.tapestry.IScriptProcessor} with a handful of additional methods | |
19 | * needed when rendering a page response. | |
20 | * | |
21 | * @author Howard M. Lewis Ship | |
22 | * @since 4.0 | |
23 | * @see org.apache.tapestry.html.Body | |
24 | * @see org.apache.tapestry.TapestryUtils#getPageRenderSupport(IRequestCycle, IComponent) | |
25 | */ | |
26 | public interface PageRenderSupport extends IScriptProcessor | |
27 | { | |
28 | /** | |
29 | * Sets up the given URL to preload, and returns a reference to the loaded image, in the form of | |
30 | * a snippet of JavaScript expression that can be inserted into some larger block of JavaScript | |
31 | * as a function parameter, or as a property assignment. A typical return value might be | |
32 | * <code>tapestry_preload[7].src</code>. | |
33 | * | |
34 | * @param url | |
35 | * The url to the resource to be preloaded. | |
36 | * @return Reference to preload image url. | |
37 | * @deprecated To be removed in 4.2, use {@link #getPreloadedImageReference(IComponent, String)} | |
38 | * or {@link #getPreloadedImageReference(IComponent, IAsset)} instead. | |
39 | */ | |
40 | ||
41 | String getPreloadedImageReference(String url); | |
42 | ||
43 | /** | |
44 | * Operates in the same way that {@link #getPreloadedImageReference(IComponent, String)} does, except | |
45 | * the source is the actual {@link IAsset} of an image to preload. | |
46 | * | |
47 | * @param target | |
48 | * The component the asset is being loaded for. | |
49 | * @param source | |
50 | * The asset image to preload. | |
51 | * @return The url representing the image that can be safely retrieved by the browser to see it. | |
52 | */ | |
53 | String getPreloadedImageReference(IComponent target, IAsset source); | |
54 | ||
55 | /** | |
56 | * Sets up the given URL to preload, and returns a reference to the loaded image, in the form of | |
57 | * a snippet of JavaScript expression that can be inserted into some larger block of JavaScript | |
58 | * as a function parameter, or as a property assignment. A typical return value might be | |
59 | * <code>tapestry_preload[7].src</code>. | |
60 | * | |
61 | * @param target | |
62 | * The component url being loaded for. | |
63 | * @param url | |
64 | * The asset URL to preload. | |
65 | * @return Reference to preload image url. | |
66 | */ | |
67 | ||
68 | String getPreloadedImageReference(IComponent target, String url); | |
69 | } |