<a:ClientSideScript>

TBD

Bindings

filename	TBD	String (get)
language	TBD	String (get)
isSingleton	Only meaningful when not using scriptFile binding and the AWClientSideScript is used to render a script block. By default, the value of this binding is $true. If a reusable component uses an AWClientSideScript to define a block of inline script this binding should most likely be set binding to false or else only a single instance of the script block will be rendered per page. When this binding is set to $false, care should be taken with the declaration of global variables as the declaration may be rendered multiple times.	boolean (get)
scriptFile	TBD	String (get)
scriptString	TBD	String (get)
elementId	TBD	String (set)
invokeAction	TBD	method (get)
executeOnIncrementalUpdate	Indicates that this script should be executed on a full page refresh as well an incremental update of an AWRefreshRegion including this script. In the incremental update case, all DOM updates will be applied before AWClientSideScript's are executed. AWClientSideScript's are executed in the context of the main application window. In order to have a method execute on every refresh of a page, regardless of whether or not its containing AWRefreshRegion is rendered, use executeOnIncrementalUpdate=false and call the Event.registerRefreshCallback() to register the method to call, or use executeOn="onupdate".	boolean (get)
globalScope	Implies that the script should be run inline (immediately when encountered whether that is in the refresh frame or in the main document window).	boolean (get)
forceDirectInclude	Include file directly (instead of via async XMLHTTP).	boolean (get)
synchronous	Execute inline scripts synchronously (instead of after dom update complete).	boolean (get)
executeOn	If specified, then this script will be run upon the specified window / document event. Supported events include: "onfocusin", "onload"	String (get)
handle	If bound, will push a string that can be used in an event handler to invoke this code. E.g. some script here ...		String (set)
RJSMayNotBeDefined	Option to encapsulate the JS function in RJS if defined, else create RJS function that evaluate the function right away. Creating RJS is fine because if Request.js is included later, it will overwrite this RJS function.	boolean (get)

ariba.ui.aribaweb.html
Class AWClientSideScript

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.aribaweb.html.AWClientSideScript

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public final class AWClientSideScript
extends AWComponent

Nested Class Summary

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWComponent

AWComponent.RenderingFilter, AWComponent.RenderingListener

Nested classes/interfaces inherited from interface ariba.ui.aribaweb.core.AWResponseGenerating

AWResponseGenerating.ResponseSubstitution

Constructor Summary

AWClientSideScript()

Method Summary

boolean	formatInPre()
boolean	hasScriptBinding()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
java.lang.String	scriptFileUrl()
java.lang.String	scriptString()
void	setupSpanId()
java.lang.String[]	supportedBindingNames()
boolean	useDirectGlobalScript()
boolean	useDirectInclude()
java.lang.String	vbsFlag()

Methods inherited from class ariba.ui.aribaweb.core.AWComponent

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, applyValues, awcyclePageAndLog, bindingForName, bindingForName, bindings, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browserMaxWidth, browserMinWidth, characterEncoding, clearValidationError, clientTimeZone, componentConfiguration, componentDefinition, componentPath, componentReference, createPageWithName, defaultTemplateParser, determineInstance, determineInstance, dict, dict, dict, doubleValueForBinding, doubleValueForBinding, doubleValueForBinding, encodedStringValueForBinding, encodedStringValueForBinding, ensureAwake, ensureFieldValuesClear, env, errorManager, escapeAttribute, escapeString, escapeUnsafeString, extendedFields, formValueManager, generateResponse, generateResponse, generateResponse, generateStringContents, getAWParameter, getDrivingBusinessObject, getFoldInSituOnWindowSizeParam, getPageRenderVersion, getThis, hasBinding, hasBinding, hasContentForTagName, hasContentNamed, hasMultipleTemplates, hasSubTemplateNamed, httpSession, init, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, invokeAction, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStateless, isStrictTagNaming, isUserCommunityEnabled, isValidationEnabled, languageDirection, languageLeft, languageRight, loadTemplate, localizedJavaString, markBacktrackState, name, namePath, notifyChange, otherBindings, otherBindingsValues, page, pageComponent, pageWithClass, pageWithClass, pageWithName, pageWithName, parent, postTakeValueActions, preferredLocale, recordBacktrackState, recordBacktrackState, recordValidationError, recordValidationError, recordValidationError, recordValidationErrors, recordValidationWarning, redirectToPage, registerRenderingListener, registerXmlNodeWithName, removeBacktrackState, replacementResponse, request, requestContext, requiresPreGlidCompatibility, resourceClassName, resourceManager, response, restoreFromBacktrackState, session, session, setCharacterEncoding, setClientPanel, setClientTimeZone, setComponentConfiguration, setDefaultTemplateParser, setEnv, setPerfDestinationInfo, setPreferredLocale, setResourceManager, setTemplateParser, setupForNextCycle, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, shouldCachePage, shouldCloseElements, strings, stringValueForBinding, stringValueForBinding, stringValueForBinding, template, templateName, templateParser, templateResource, templateResourceManager, truncateBacktrackState, truncateBacktrackState, urlForResourceNamed, urlForResourceNamed, urlForResourceNamed, useXmlEscaping, valueForBinding, valueForBinding, valueForBinding, xml

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, getFieldValue, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, isKindOfClass, setFieldValue

Field Detail

_filename

public java.lang.String _filename

_isGlobalScope

public boolean _isGlobalScope

_isVBScript

public boolean _isVBScript

_spanId

public AWEncodedString _spanId

_executeOn

public java.lang.String _executeOn

Constructor Detail

AWClientSideScript

public AWClientSideScript()

Method Detail

useDirectInclude

public boolean useDirectInclude()

useDirectGlobalScript

public boolean useDirectGlobalScript()

formatInPre

public boolean formatInPre()

renderResponse

public void renderResponse(AWRequestContext requestContext,
                           AWComponent component)

Description copied from interface: AWCycleable

The receiver should render its content to the AWRequestContext.response()

Specified by:

renderResponse in interface AWCycleable

Overrides:

renderResponse in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

supportedBindingNames

public java.lang.String[] supportedBindingNames()

Overrides:

supportedBindingNames in class AWComponent

scriptFileUrl

public java.lang.String scriptFileUrl()

hasScriptBinding

public boolean hasScriptBinding()

scriptString

public java.lang.String scriptString()

setupSpanId

public void setupSpanId()

vbsFlag

public java.lang.String vbsFlag()