Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.tapestry.html
Class Body

java.lang.Object
  extended by org.apache.hivemind.impl.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.html.Body
All Implemented Interfaces:
Locatable, LocationHolder, IComponent, IDirectEvent, IRender, IScriptProcessor, PageRenderSupport
public abstract class Body
extends AbstractComponent
implements PageRenderSupport

The body of a Tapestry page. This is used since it allows components on the page access to an initialization script (that is written the start, just inside the <body> tag). This is currently used by Rolloverand Scriptcomponents. [ Component Reference ]

Author:
Howard Lewis Ship

Field Summary
 
Fields inherited from class org.apache.tapestry.AbstractComponent
_clientId
 
Constructor Summary
Body()
           
 
Method Summary
 void addBodyScript(IComponent target, String script)
          Adds scripting code to the main body.
 void addBodyScript(String script)
          Adds additional scripting code to the page.
 void addExternalScript(IComponent target, Resource scriptLocation)
          Adds an external script.
 void addExternalScript(Resource scriptLocation)
          Used to include a script from an outside URL (the scriptLocation is a URL, probably obtained from an asset.
 void addInitializationScript(IComponent target, String script)
          Adds initialization script.
 void addInitializationScript(String script)
          Adds other initialization, in the form of additional JavaScript code to execute from the <body>'s onLoad event handler.
protected  void cleanupAfterRender(IRequestCycle cycle)
          Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders.
abstract  AssetFactory getAssetFactory()
          Injected.
abstract  String getElement()
          Parameter.
abstract  ComponentRenderWorker getEventWorker()
          Injected.
 String getPreloadedImageReference(IComponent target, String URL)
          Sets up the given URL to preload, and returns a reference to the loaded image, in the form of a snippet of JavaScript expression that can be inserted into some larger block of JavaScript as a function parameter, or as a property assignment.
 String getPreloadedImageReference(String URL)
          Deprecated. To be removed in 4.2, use getPreloadedImageReference(IComponent, String) instead.
abstract  WebResponse getResponse()
          Injected.
 String getUniqueString(String baseValue)
          Ensures that the given string is unique.
protected  void prepareForRender(IRequestCycle cycle)
          Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to prepare the component to render.
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, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setId, setNamespace, setPage, toString, triggerEvent
 
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

Body

public Body()
Method Detail

getPreloadedImageReference

public String getPreloadedImageReference(IComponent target,
                                         String URL)
Sets up the given URL to preload, and returns a reference to the loaded image, in the form of a snippet of JavaScript expression that can be inserted into some larger block of JavaScript as a function parameter, or as a property assignment. A typical return value might be tapestry_preload[7].src.

Specified by:
getPreloadedImageReference in interface PageRenderSupport
Parameters:
target - The component url being loaded for
URL - The asset URL to preload

getPreloadedImageReference

public String getPreloadedImageReference(String URL)
Deprecated. To be removed in 4.2, use getPreloadedImageReference(IComponent, String) instead.

Adds to the script an initialization for the named variable as an Image(), to the given URL.

Returns a reference, a string that can be used to represent the preloaded image in a JavaScript function.

Specified by:
getPreloadedImageReference in interface PageRenderSupport
Since:
1.0.2

addInitializationScript

public void addInitializationScript(String script)
Adds other initialization, in the form of additional JavaScript code to execute from the <body>'s onLoad event handler. The caller is responsible for adding a semicolon (statement terminator). This method will add a newline after the script.

Specified by:
addInitializationScript in interface IScriptProcessor
See Also:
#addInitializationScript(IComponent, String)}

addInitializationScript

public void addInitializationScript(IComponent target,
                                    String script)
Adds initialization script. Initialization script is executed once, when the containing page loads. Initialization script content is written only after all HTML content that could be referenced from the script (in effect, just before the </body> tag).

Specified by:
addInitializationScript in interface IScriptProcessor
Parameters:
target - The component the script is being added for.
script - The script to add.

addBodyScript

public void addBodyScript(String script)
Adds additional scripting code to the page. This code will be added to a large block of scripting code at the top of the page (i.e., the before the <body> tag).

This is typically used to add some form of JavaScript event handler to a page. For example, the Rollovercomponent makes use of this.

Another way this is invoked is by using the Scriptcomponent.

The string will be added, as-is, within the <script> block generated by this Body component. The script should not contain HTML comments, those will be supplied by this Body component.

A frequent use is to add an initialization function using this method, then cause it to be executed using addInitializationScript(String).

Specified by:
addBodyScript in interface IScriptProcessor
See Also:
#addBodyScript(IComponent, String)}

addBodyScript

public void addBodyScript(IComponent target,
                          String script)
Adds scripting code to the main body. During the render, multiple scripts may render multiple bodies; all are concatinated together to form a single block. The Body component will write the body script contents just inside the <body> tag.

Specified by:
addBodyScript in interface IScriptProcessor
Parameters:
target - The component this script is being added for.
script - The script to add to the body response.

addExternalScript

public void addExternalScript(Resource scriptLocation)
Used to include a script from an outside URL (the scriptLocation is a URL, probably obtained from an asset. This adds an <script src="..."> tag before the main <script> tag. The Body component ensures that each URL is included only once.

Specified by:
addExternalScript in interface IScriptProcessor
Since:
1.0.5
See Also:
#addExternalScript(IComponent, Resource)}

addExternalScript

public void addExternalScript(IComponent target,
                              Resource scriptLocation)
Adds an external script. The processor is expected to ensure that external scripts are only loaded a single time per page. The target will be checked to filter the scripts added for those types of responses that require them.

Specified by:
addExternalScript in interface IScriptProcessor
Parameters:
target - The component the script is being added for.
scriptLocation - The external script to add.

prepareForRender

protected void prepareForRender(IRequestCycle cycle)
Description copied from class: AbstractComponent
Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to prepare the component to render. This implementation sets JavaBeans properties from matching bound parameters. The default implementation of this method is empty.

Overrides:
prepareForRender in class AbstractComponent

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

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

getElement

public abstract String getElement()
Parameter.

getAssetFactory

public abstract AssetFactory getAssetFactory()
Injected.

Since:
4.0

getResponse

public abstract WebResponse getResponse()
Injected.

Since:
4.0

getEventWorker

public abstract ComponentRenderWorker getEventWorker()
Injected.

Returns:
Since:
4.1

getUniqueString

public String getUniqueString(String baseValue)
Description copied from interface: IScriptProcessor
Ensures that the given string is unique. The string is either returned unchanged, or a suffix is appended to ensure uniqueness.

Specified by:
getUniqueString in interface IScriptProcessor
Since:
3.0
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2006 Apache Software Foundation. All Rights Reserved.