JavaScriptSupportImpl (Tapestry API Documentation)

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.tapestry5.internal.services.ajax
Class JavaScriptSupportImpl

java.lang.Object
  org.apache.tapestry5.internal.services.ajax.JavaScriptSupportImpl

All Implemented Interfaces:: JavaScriptSupport

public class JavaScriptSupportImpl
extends Object
implements JavaScriptSupport
extends Object
implements JavaScriptSupport

Constructor Summary
`JavaScriptSupportImpl(DocumentLinker linker, JavaScriptStackSource javascriptStackSource, JavaScriptStackPathConstructor stackPathConstructor)`
`JavaScriptSupportImpl(DocumentLinker linker, JavaScriptStackSource javascriptStackSource, JavaScriptStackPathConstructor stackPathConstructor, IdAllocator idAllocator, boolean partialMode)`

Method Summary
`void`	`addInitializerCall(InitializationPriority priority, String functionName, JSONArray parameter)` Adds a call to a client-side function inside the Tapestry.Initializer namespace.
`void`	`addInitializerCall(InitializationPriority priority, String functionName, JSONObject parameter)` Adds a call to a client-side function inside the Tapestry.Initializer namespace.
`void`	`addInitializerCall(InitializationPriority priority, String functionName, String parameter)` Adds a call to a client-side function inside the Tapestry.Initializer namespace.
`void`	`addInitializerCall(String functionName, JSONArray parameter)` Adds a call to a client-side function inside the Tapestry.Initializer namespace.
`void`	`addInitializerCall(String functionName, JSONObject parameter)` Adds a call to a client-side function inside the Tapestry.Initializer namespace.
`void`	`addInitializerCall(String functionName, String parameter)` Adds a call to a client-side function inside the Tapestry.Initializer namespace.
`void`	`addScript(InitializationPriority priority, String format, Object... arguments)` Adds initialization script at the specified priority.
`void`	`addScript(String format, Object... arguments)` Adds initialization script at `InitializationPriority.NORMAL` priority.
`String`	`allocateClientId(ComponentResources resources)` As with `JavaScriptSupport.allocateClientId(String)` but uses the id of the component extracted from the resources.
`String`	`allocateClientId(String id)` Allocates a unique id based on the component's id.
`void`	`autofocus(FieldFocusPriority priority, String fieldId)` Invoked to set focus on a rendered field.
`void`	`commit()`
`void`	`importJavaScriptLibrary(Asset asset)` Imports a JavaScript library as part of the rendered page.
`void`	`importJavaScriptLibrary(String libraryURL)` Import a Javascript library with an arbitrary URL.
`void`	`importStack(String stackName)` Imports a `JavaScriptStack` by name, a related set of JavaScript libraries and stylesheets.
`void`	`importStylesheet(Asset stylesheet)` A convenience method that wraps the Asset as a `StylesheetLink`.
`void`	`importStylesheet(StylesheetLink stylesheetLink)` Imports a Cascading Style Sheet file as part of the rendered page.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

JavaScriptSupportImpl

public JavaScriptSupportImpl(DocumentLinker linker,
                             JavaScriptStackSource javascriptStackSource,
                             JavaScriptStackPathConstructor stackPathConstructor)

JavaScriptSupportImpl

public JavaScriptSupportImpl(DocumentLinker linker,
                             JavaScriptStackSource javascriptStackSource,
                             JavaScriptStackPathConstructor stackPathConstructor,
                             IdAllocator idAllocator,
                             boolean partialMode)

Parameters:: linker - responsible for assembling all the information gathered by JavaScriptSupport and attaching it to the Document (for a full page render) or to the JSON response (in a partial render); javascriptStackSource - source of information about JavaScriptStacks, used when handling the import of libraries and stacks (often, to handle transitive dependencies); stackPathConstructor - encapsulates the knowledge of how to represent a stack (which may be converted from a series of JavaScript libraries into a single virtual JavaScript library); idAllocator - used when allocating unique ids (it is usually pre-initialized in an Ajax request to ensure that newly allocated ids do not conflict with previous renders and partial updates); partialMode - if true, then the JSS configures itself for a partial page render (part of an Ajax request) which automatically assumes the "core" library has been added (to the original page render) and makes other minor changes to behavior.

Method Detail