org.apache.tapestry.html
Class Script

java.lang.Object
  org.apache.tapestry.spec.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.html.Script

All Implemented Interfaces:

IComponent, ILocatable, ILocationHolder, IRender

public abstract class Script
extends AbstractComponent

Works with the Body component to add a script (and perhaps some initialization) to the HTML response. [Component Reference]

Version:

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

Author:

Howard Lewis Ship

Constructor Summary

Script()

Method Summary

protected void	cleanupAfterRender(IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) after the component renders, to clear any parameters back to null (or 0, or false, or whatever the correct default is).
Map	getBaseSymbols()
abstract String	getScriptPath()
Map	getSymbols() Returns the complete set of symbols (input and output) from the script execution.
protected void	renderComponent(IMarkupWriter writer, IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to actually render the component (with any parameter values already set).
void	setBaseSymbols(Map baseSymbols)

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, finishLoad, finishLoad, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, format, format, format, format, formatString, formatString, formatString, formatString, generateAttributes, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getChangeObserver, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, getString, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainer, setId, setNamespace, setPage, setProperty, setSpecification, toString

Methods inherited from class org.apache.tapestry.spec.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tapestry.ILocationHolder

setLocation

Methods inherited from interface org.apache.tapestry.ILocatable

getLocation

Constructor Detail

Script

public Script()

Method Detail

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)

Description copied from class: AbstractComponent

Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to actually render the component (with any parameter values already set). This is the method that subclasses must implement.

Specified by:

renderComponent in class AbstractComponent

getScriptPath

public abstract String getScriptPath()

getBaseSymbols

public Map getBaseSymbols()

setBaseSymbols

public void setBaseSymbols(Map baseSymbols)

getSymbols

public Map getSymbols()

Returns the complete set of symbols (input and output) from the script execution. This is visible to the body of the Script, but is cleared after the Script finishes rendering.

Since:

2.2

cleanupAfterRender

protected void cleanupAfterRender(IRequestCycle cycle)

Description copied from class: AbstractComponent

Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) after the component renders, to clear any parameters back to null (or 0, or false, or whatever the correct default is). Primarily, this is used to ensure that the component doesn't hold onto any objects that could otherwise be garbage collected.

Subclasses may override this implementation, but must also invoke it.

Overrides:

cleanupAfterRender in class AbstractComponent