er.ajax

Class AjaxUtils

java.lang.Object

er.ajax.AjaxUtils

Direct Known Subclasses:

MTAjaxUtils

public class AjaxUtils
extends Object

Properties

Name	Description
er.ajax.compressed	er.ajax.compressed
er.extensions.ERXResponseRewriter.javascriptTypeAttribute	er.extensions.ERXResponseRewriter.javascriptTypeAttribute

Constructor Summary

Constructors

Constructor and Description
AjaxUtils()

Method Summary

Modifier and Type	Method and Description
static void	addScriptCodeInHead(WOResponse response, WOContext context, String script) Calls ERXResponseRewriter.addScriptCodeInHead(WOResponse, WOContext, String).
static void	addScriptResourceInHead(WOContext context, WOResponse response, String fileName) Calls addScriptResourceInHead(WOContext, WOResponse, String, String) with "Ajax" as framework.
static void	addScriptResourceInHead(WOContext context, WOResponse response, String framework, String fileName) Adds a script tag with a correct resource URL in the HTML head tag if it isn't already present in the response.
static void	addStylesheetResourceInHead(WOContext context, WOResponse response, String fileName) Calls addStylesheetResourceInHead(WOContext, WOResponse, String, String) with "Ajax" as framework.
static void	addStylesheetResourceInHead(WOContext context, WOResponse response, String framework, String fileName) Calls ERXResponseRewriter.addStylesheetResourceInHead(WOResponse, WOContext, String, String)
static String	ajaxComponentActionUrl(WOContext context) Returns an Ajax component action url.
static void	appendScript(WOContext context, String script) Shortcut for appendScript.
static void	appendScript(WORequest request, WOResponse response, String script) Appends the given javascript to the response, surrounding it in a script header/footer if necessary.
static void	appendScriptFooter(WOResponse response)
static void	appendScriptFooterIfNecessary(WORequest request, WOResponse response)
static void	appendScriptHeader(WOResponse response)
static void	appendScriptHeaderIfNecessary(WORequest request, WOResponse response)
static void	appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, NSDictionary<String,WOAssociation> associations, String name)
static void	appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, NSDictionary<String,WOAssociation> associations, String name, String appendValue)
static void	appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, String name, WOAssociation association)
static void	appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, String name, WOAssociation association, String appendValue)
static <T> NSArray<T>	arrayValueForAssociation(WOComponent component, WOAssociation association) Returns the array bound to the given association.
static <T> NSArray<T>	arrayValueForBinding(WOComponent component, String bindingName) Returns the array bound to the given binding name.
static <T> NSArray<T>	arrayValueForObject(Object value) Returns the array for the given object.
static AjaxResponse	createResponse(WORequest request, WOContext context) Creates a response for the given context (which can be null), sets the charset to UTF-8, the connection to keep-alive and flags it as a Ajax request by adding an AJAX_REQUEST_KEY header.
static boolean	isAjaxRequest(WORequest request) Return whether or not the given request is an Ajax request.
static WOResponse	javascriptResponse(String javascript, WOContext context) Returns an AjaxResponse with the given javascript as the body of the response.
static String	quote(String value) If the value is null, this returns "null", otherwise it returns '[value]'.
static void	redirectTo(WOComponent component) Creates (or modifies if already created) an AjaxResponse to redirect to the passed component with a component action.
static void	setPageReplacementCacheKey(WOContext _context, String _key)
static boolean	shouldHandleRequest(WORequest request, WOContext context, String containerID)
static void	updateDomElement(WOResponse response, String id, Object value, String numberFormat, String dateFormat, String valueWhenEmpty) updateDomElement appends JavaScript code to the given AjaxResponse that updates the content of the DOM Element with the given ID to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxUtils

public AjaxUtils()

Method Detail

quote

public static String quote(String value)

If the value is null, this returns "null", otherwise it returns '[value]'.

Parameters:

value - the value to quote

Returns:

the quoted value or "null"

isAjaxRequest

public static boolean isAjaxRequest(WORequest request)

Return whether or not the given request is an Ajax request.

Parameters:

request - the request the check

Returns:

if it an Ajax request the true

setPageReplacementCacheKey

public static void setPageReplacementCacheKey(WOContext _context,
                                              String _key)

createResponse

public static AjaxResponse createResponse(WORequest request,
                                          WOContext context)

Creates a response for the given context (which can be null), sets the charset to UTF-8, the connection to keep-alive and flags it as a Ajax request by adding an AJAX_REQUEST_KEY header. You can check this header in the session to decide if you want to save the request or not.

Parameters:

request - the current request

context - the current context

Returns:

a new Ajax response

addScriptResourceInHead

public static void addScriptResourceInHead(WOContext context,
                                           WOResponse response,
                                           String framework,
                                           String fileName)

Adds a script tag with a correct resource URL in the HTML head tag if it isn't already present in the response.

Parameters:

context - the context

response - the response to write into

framework - the framework that contains the file

fileName - the name of the javascript file to add

addScriptResourceInHead

public static void addScriptResourceInHead(WOContext context,
                                           WOResponse response,
                                           String fileName)

Calls addScriptResourceInHead(WOContext, WOResponse, String, String) with "Ajax" as framework.

Parameters:

context - the context

response - the response to write into

fileName - the name of the javascript file to add

addStylesheetResourceInHead

public static void addStylesheetResourceInHead(WOContext context,
                                               WOResponse response,
                                               String framework,
                                               String fileName)

Calls ERXResponseRewriter.addStylesheetResourceInHead(WOResponse, WOContext, String, String)

Parameters:

context - the context

response - the response to write into

framework - the framework that contains the file

fileName - the name of the CSS file to add

addStylesheetResourceInHead

public static void addStylesheetResourceInHead(WOContext context,
                                               WOResponse response,
                                               String fileName)

Calls addStylesheetResourceInHead(WOContext, WOResponse, String, String) with "Ajax" as framework.

Parameters:

context - the context

response - the response to write into

fileName - the name of the CSS file to add

addScriptCodeInHead

public static void addScriptCodeInHead(WOResponse response,
                                       WOContext context,
                                       String script)

Calls ERXResponseRewriter.addScriptCodeInHead(WOResponse, WOContext, String).

Parameters:

response - the response to write into

context - the context

script - the javascript code to insert

shouldHandleRequest

public static boolean shouldHandleRequest(WORequest request,
                                          WOContext context,
                                          String containerID)

javascriptResponse

public static WOResponse javascriptResponse(String javascript,
                                            WOContext context)

Returns an AjaxResponse with the given javascript as the body of the response.

Parameters:

context - the context

javascript - the javascript to send

Returns:

a new response

appendScript

public static void appendScript(WOContext context,
                                String script)

Shortcut for appendScript.

Parameters:

context - the context

script - the script to append

appendScript

public static void appendScript(WORequest request,
                                WOResponse response,
                                String script)

Appends the given javascript to the response, surrounding it in a script header/footer if necessary.

Parameters:

request - the request

response - the response

script - the script to append

appendScriptHeaderIfNecessary

public static void appendScriptHeaderIfNecessary(WORequest request,
                                                 WOResponse response)

appendScriptHeader

public static void appendScriptHeader(WOResponse response)

appendScriptFooterIfNecessary

public static void appendScriptFooterIfNecessary(WORequest request,
                                                 WOResponse response)

appendScriptFooter

public static void appendScriptFooter(WOResponse response)

arrayValueForAssociation

public static <T> NSArray<T> arrayValueForAssociation(WOComponent component,
                                                      WOAssociation association)

Returns the array bound to the given association.

Type Parameters:

T - the array type

Parameters:

component - the component to resolve against

association - the association to retrieve a value for

Returns:

an array (or null)

arrayValueForBinding

public static <T> NSArray<T> arrayValueForBinding(WOComponent component,
                                                  String bindingName)

Returns the array bound to the given binding name.

Type Parameters:

T - the array type

Parameters:

component - the component to resolve against

bindingName - the name of the binding

Returns:

an array (or null)

arrayValueForObject

public static <T> NSArray<T> arrayValueForObject(Object value)

Returns the array for the given object. If the object is a string, it will be parsed as a JSON value.

Type Parameters:

T - the array type

Parameters:

value - the object value

Returns:

an array (or null)

ajaxComponentActionUrl

public static String ajaxComponentActionUrl(WOContext context)

Returns an Ajax component action url. Using an ajax component action urls guarantees that caching during your ajax request will be handled appropriately.

Parameters:

context - the context of the request

Returns:

an ajax request url.

appendTagAttributeAndValue

public static void appendTagAttributeAndValue(WOResponse response,
                                              WOContext context,
                                              WOComponent component,
                                              NSDictionary<String,WOAssociation> associations,
                                              String name)

appendTagAttributeAndValue

public static void appendTagAttributeAndValue(WOResponse response,
                                              WOContext context,
                                              WOComponent component,
                                              NSDictionary<String,WOAssociation> associations,
                                              String name,
                                              String appendValue)

appendTagAttributeAndValue

public static void appendTagAttributeAndValue(WOResponse response,
                                              WOContext context,
                                              WOComponent component,
                                              String name,
                                              WOAssociation association)

appendTagAttributeAndValue

public static void appendTagAttributeAndValue(WOResponse response,
                                              WOContext context,
                                              WOComponent component,
                                              String name,
                                              WOAssociation association,
                                              String appendValue)

redirectTo

public static void redirectTo(WOComponent component)

Creates (or modifies if already created) an AjaxResponse to redirect to the passed component with a component action. Anything previously written to the AjaxResponse is preserved.

Parameters:

component - full page WOComponent instance to redirect to

updateDomElement

public static void updateDomElement(WOResponse response,
                                    String id,
                                    Object value,
                                    String numberFormat,
                                    String dateFormat,
                                    String valueWhenEmpty)

updateDomElement appends JavaScript code to the given AjaxResponse that updates the content of the DOM Element with the given ID to the specified value. Useful if you want to update multiple small regions on a page with a single request, e.g. when an AjaxObserveField triggers an action.

This method is also available on instances. The example below uses the method on AjaxResponse.

 public WOActionResults cartItemChanged() {
        ShoppingCart cart; // assume this exists
        ShoppingCartItem item; // assume this exists
        AjaxResponse response = AjaxUtils.createResponse(context().request(), context());
        response.appendScriptHeaderIfNecessary();
        response.updateDomElement("orderAmount_" + item.primaryKey(), item.orderAmount(), "#,##0.", null, null);
        response.updateDomElement("price_" + item.primaryKey(), item.priceForOrderAmount(), "#,##0.00", null, null);
        response.updateDomElement("shoppingCartPrice", cart.totalPrice(), "#,##0.00", null, null);
        response.appendScriptFooterIfNecessary();
        return response;
 }
 

Parameters:

response - The response to append the JavaScript to

id - ID of the DOM element to update

value - The new value

numberFormat - optional number format to format the value with

dateFormat - optional date format to format the value with

valueWhenEmpty - string to use when value is null

See Also:

AjaxResponse.updateDomElement(String, Object, String, String, String), AjaxResponse.updateDomElement(String, Object)