org.apache.tapestry5.RenderSupport Maven / Gradle / Ivy
Show all versions of tapestry-core Show documentation
// Copyright 2006, 2007, 2008, 2009, 2010 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package org.apache.tapestry5;
import org.apache.tapestry5.annotations.Environmental;
import org.apache.tapestry5.ioc.services.SymbolSource;
import org.apache.tapestry5.json.JSONArray;
import org.apache.tapestry5.json.JSONObject;
import org.apache.tapestry5.services.AssetSource;
import org.apache.tapestry5.services.EnvironmentalShadowBuilder;
import org.apache.tapestry5.services.javascript.JavaScriptSupport;
/**
* Provides support to all components that render. This is primarily about generating unique client-side ids (very
* important for JavaScript generation) as well as accumulating JavaScript to be sent to the client. PageRenderSupport
* also allows for the incremental addition of stylesheets.
*
* When rendering, a <script> block will be added to the bottom of the page (just before the </body> tag).
* The scripting statements added to this block will be executed, on the client, only once the page has fully loaded.
*
* The methods in this interface are largely being replaced with a new environmental interface,
* {@link JavaScriptSupport}.
*
* RenderSupport is normally accessed within a component by using the {@link Environmental} annotation on a component
* field. In addition, RenderSupport may also be accessed as a service (the service
* {@linkplain EnvironmentalShadowBuilder internally delegates to the current environmental instance}), which is useful
* for service-layer objects.
*
* @deprecated RenderSupport has been replaced by {@link JavaScriptSupport} and may be removed in Tapestry 5.3.
*/
public interface RenderSupport
{
/**
* Allocates a unique id based on the component's id. In some cases, the return value will not precisely match the
* input value (an underscore and a unique index value may be appended).
*
* @param id
* the component id from which a unique id will be generated
* @return a unique id for this rendering of the page
* @see org.apache.tapestry5.ioc.util.IdAllocator
* @see JavaScriptSupport#allocateClientId(ComponentResources)
* @deprecated Use {@link JavaScriptSupport#allocateClientId(String)} instead
*/
String allocateClientId(String id);
/**
* As with {@link #allocateClientId(String)} but uses the id of the component extracted from the resources.
*
* @param resources
* of the component which requires an id
* @return a unique id for this rendering of the page
* @deprecated Use {@link JavaScriptSupport#allocateClientId(ComponentResources)} instead
*/
String allocateClientId(ComponentResources resources);
/**
* Adds one or more new script assets to the page. Assets are added uniquely, and appear as <script> elements
* just inside the <body> element of the rendered page. Duplicate requests to add the same script are quietly
* ignored.
*
* @param scriptAssets
* asset to the script to add
* @deprecated Use {@link JavaScriptSupport#importJavaScriptLibrary(Asset)} instead
*/
void addScriptLink(Asset... scriptAssets);
/**
* Adds some number of script links as strings representations of URLs. The scripts are passed down to the client
* as-is. Typically, this is used to reference a script stored outside the web application entirely.
*
* @param scriptURLs
* URL strings of scripts
* @deprecated Use {@link JavaScriptSupport#importJavaScriptLibrary(String)} instead
* @throws RuntimeException
* always as of 5.2.0
*/
void addScriptLink(String... scriptURLs);
/**
* Used to add scripts that are stored on the classpath. Each element has {@linkplain SymbolSource symbols
* expanded}, then is {@linkplain AssetSource converted to an asset} and added as a script link.
*
* @param classpaths
* array of paths. Symbols in the paths are expanded, then the paths are each converted into an
* asset.
* @deprecated Use {@link JavaScriptSupport#importJavaScriptLibrary(Asset)} instead
*/
void addClasspathScriptLink(String... classpaths);
/**
* Adds a link to a CSS stylesheet. As with JavaScript libraries, each stylesheet is added at most once. Stylesheets
* added this way will be ordered before any other content, in the <head> element of the document. The
* <head> element will be created, if necessary.
*
* @param stylesheet
* the asset referencing the stylesheet
* @param media
* the media value for the stylesheet, or null to not specify a specific media type
*/
void addStylesheetLink(Asset stylesheet, String media);
/**
* Adds a stylesheet as a URL. See notes in {@link #addScriptLink(String[])}.
*
* @param stylesheetURL
* URL string of stylesheet
* @param media
* media value for the stylesheet, or null to not specify a specific media type
*/
void addStylesheetLink(String stylesheetURL, String media);
/**
* Adds a script statement to the page's script block. A newline will be added after the script statement.
*
* @param script
* text to be added to the script block
* @deprecated Use {@link JavaScriptSupport#addScript(String, Object...)} instead
*/
void addScript(String script);
/**
* Adds a script statement to the page's script block. The parameters are passed to
* {@link String#format(String, Object[])} before being added to the script block. A newline will be added after the
* formatted statement.
*
* @param format
* base string format, to be passed through String.format
* @param arguments
* additional arguments formatted to form the final script
* @deprecated Use {@link JavaScriptSupport#addScript(String, Object...)} instead
*/
void addScript(String format, Object... arguments);
/**
* Add an initialization call. This method is deprecated and, although it still works, it now generates
* very verbose, inefficient client-side JavaScript.
*
* @param functionName
* the name of the function (on the client-side Tapestry.Initializer object) to invoke.
* @param parameterList
* list of parameters for the method invocation.
* @see #addScript(String, Object[])
* @deprecated Use {@link JavaScriptSupport#addInitializerCall(String, JSONObject)} instead (which may require
* changes to your JavaScript initializer function)
*/
void addInit(String functionName, JSONArray parameterList);
/**
* Alternate version of {@link #addInit(String, org.apache.tapestry5.json.JSONArray)} where just a single object is
* passed.
*
* @param functionName
* the name of the function (on the client-side Tapestry object) to invoke.
* @param parameter
* the object to pass to the function
* @deprecated Use {@link JavaScriptSupport#addInitializerCall(String, JSONObject)} instead
*/
void addInit(String functionName, JSONObject parameter);
/**
* Alternate version of {@link #addInit(String, org.apache.tapestry5.json.JSONArray)} where one or more strings are
* passed. A single string is added to the initialization call as itself; otherwise, the parameters are combined to
* form a {@link JSONArray}. This method is deprecated and, although it still works, it now generates
* very verbose, inefficient client-side JavaScript.
*
* @param functionName
* the name of the function (on the client-side Tapestry object) to invoke.
* @param parameters
* @deprecated Use {@link JavaScriptSupport#addInitializerCall(String, JSONObject)} instead (which may require
* changes to your JavaScript initializer function), or (for a single parameter)
* {@link JavaScriptSupport#addInitializerCall(String, String)}
*/
void addInit(String functionName, String... parameters);
/**
* Invoked to set focus on a rendered field. Takes into account priority, meaning that a field with errors will take
* precedence over a merely required field, and over a field that is optional. The value
* {@link org.apache.tapestry5.FieldFocusPriority#OVERRIDE} can be used to force a particular field to receive
* focus.
*
* @param priority
* focus is set only if the provided priority is greater than the current priority
* @param fieldId
* id of client-side element to take focus
*/
void autofocus(FieldFocusPriority priority, String fieldId);
}