org.apache.tapestry.html

Class Script

java.lang.Object

org.apache.hivemind.impl.BaseLocatable

org.apache.tapestry.AbstractComponent

org.apache.tapestry.html.Script

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IComponent, IRender

public abstract class Script
extends AbstractComponent

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

Author:

Howard Lewis Ship

Constructor Summary

Constructors

Constructor and Description
Script()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cleanupAfterRender(IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders.
abstract java.util.Map	getBaseSymbols()
abstract IAsset	getScriptAsset()
abstract java.lang.String	getScriptPath()
abstract IScriptSource	getScriptSource() Injected
java.util.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).

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, checkActiveLock, enterActiveState, finishLoad, finishLoad, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty, toString

Methods inherited from class org.apache.hivemind.impl.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.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Constructor Detail

Script

public Script()

Method Detail

getScriptSource

public abstract IScriptSource getScriptSource()

Injected

Since:

4.0

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 java.lang.String getScriptPath()

getScriptAsset

public abstract IAsset getScriptAsset()

getBaseSymbols

public abstract java.util.Map getBaseSymbols()

getSymbols

public java.util.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. This implementation does nothing.

Overrides:

cleanupAfterRender in class AbstractComponent