org.apache.tapestry.engine
Interface ITemplateSource

All Known Implementing Classes:

DefaultTemplateSource

public interface ITemplateSource

A source of localized HTML templates for components. The cache is the means of access for components to load thier templates, which they need not do until just before rendering.

The template cache must be able to locate and parse templates as needed. It may maintain templates in memory.

Version:

$Id: ITemplateSource.java 243791 2004-02-19 17:38:13Z hlship $

Author:

Howard Ship

Field Summary

static String	TEMPLATE_ASSET_NAME Name of an IAsset of a component that provides the template for the asset.
static String	TEMPLATE_TAG_PARAMETER_NAME Name of the component parameter that will be automatically bound to the HTML tag that is used to insert the component in the parent template.

Method Summary

ComponentTemplate	getTemplate(IRequestCycle cycle, IComponent component) Locates the template for the component.
void	reset() Invoked to have the source clear any internal cache.

Field Detail

TEMPLATE_ASSET_NAME

static final String TEMPLATE_ASSET_NAME

Name of an IAsset of a component that provides the template for the asset. This overrides the default (that the template is in the same directory as the specification). This allows pages or component templates to be located properly, relative to static assets (such as images and stylesheets).

Since:

2.2

See Also:

Constant Field Values

TEMPLATE_TAG_PARAMETER_NAME

static final String TEMPLATE_TAG_PARAMETER_NAME

Name of the component parameter that will be automatically bound to the HTML tag that is used to insert the component in the parent template. If the parent component does not have a template (i.e. it extends AbstractComponent, not BaseComponent), then this parameter is bound to null.

Since:

3.0

See Also:

Constant Field Values

Method Detail

getTemplate

ComponentTemplate getTemplate(IRequestCycle cycle,
                              IComponent component)

Locates the template for the component.

Parameters:

cycle - The request cycle loading the template; this is required in some cases when the template is loaded from an IAsset.

component - The component for which a template should be loaded.

Throws:

ApplicationRuntimeException - if the resource cannot be located or loaded.

reset

void reset()

Invoked to have the source clear any internal cache. This is most often used when debugging an application.