Module org.apache.wicket.core

Package org.apache.wicket.core.util.string

Class JavaScriptUtils

java.lang.Object

org.apache.wicket.core.util.string.JavaScriptUtils

public class JavaScriptUtils
extends Object

Provide some helpers to write javascript related tags to the response object.

Author:

Juergen Donnerstag

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_CROSS_ORIGIN
static final String	ATTR_CSP_NONCE
static final String	ATTR_ID
static final String	ATTR_INTEGRITY
static final String	ATTR_SCRIPT_ASYNC
static final String	ATTR_SCRIPT_DEFER
static final String	ATTR_SCRIPT_SRC
static final String	ATTR_TYPE
static final String	SCRIPT_CLOSE_TAG	Script close tag including content suffix
static final String	SCRIPT_CONTENT_PREFIX	Prefix for JavaScript CDATA content.
static final String	SCRIPT_CONTENT_SUFFIX	Suffix for JavaScript CDATA content.
static final String	SCRIPT_OPEN_TAG	Script open tag including content prefix

Constructor Summary

Constructors

Constructor	Description
JavaScriptUtils()

Method Summary

Modifier and Type	Method	Description
static CharSequence	escapeQuotes(CharSequence input)	Escape single and double quotes so that they can be part of e.g. an alert call.
static void	writeCloseTag(Response response)	Write close script tag for inline script.
static void	writeInlineScript(Response response, CharSequence text, AttributeMap attributes)	Write the simple text to the response object surrounded by a script tag.
static void	writeJavaScript(Response response, CharSequence text)	Write the simple text to the response object surrounded by a script tag.
static void	writeOpenTag(Response response, AttributeMap attributes)	Write open script tag for inline script.
static void	writeScript(Response response, AttributeMap attributes)	Write a reference to a javascript file to the response object

Methods inherited from class java.lang.Object

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

Field Details

SCRIPT_CONTENT_PREFIX

public static final String SCRIPT_CONTENT_PREFIX

Prefix for JavaScript CDATA content. If this is changed, also update Wicket.Head.Contributor.processScript() function from wicket-ajax-jquery.js

See Also:

• Constant Field Values

SCRIPT_CONTENT_SUFFIX

public static final String SCRIPT_CONTENT_SUFFIX

Suffix for JavaScript CDATA content. If this is changed, also update Wicket.Head.Contributor.processScript() function from wicket-ajax-jquery.js

See Also:

• Constant Field Values

SCRIPT_OPEN_TAG

public static final String SCRIPT_OPEN_TAG

Script open tag including content prefix

See Also:

• Constant Field Values

SCRIPT_CLOSE_TAG

public static final String SCRIPT_CLOSE_TAG

Script close tag including content suffix

See Also:

• Constant Field Values

ATTR_ID

public static final String ATTR_ID

See Also:

• Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

• Constant Field Values

ATTR_SCRIPT_SRC

public static final String ATTR_SCRIPT_SRC

See Also:

• Constant Field Values

ATTR_SCRIPT_DEFER

public static final String ATTR_SCRIPT_DEFER

See Also:

• Constant Field Values

ATTR_SCRIPT_ASYNC

public static final String ATTR_SCRIPT_ASYNC

See Also:

• Constant Field Values

ATTR_CSP_NONCE

public static final String ATTR_CSP_NONCE

See Also:

• Constant Field Values

ATTR_CROSS_ORIGIN

public static final String ATTR_CROSS_ORIGIN

See Also:

• Constant Field Values

ATTR_INTEGRITY

public static final String ATTR_INTEGRITY

See Also:

• Constant Field Values

Constructor Details

JavaScriptUtils

public JavaScriptUtils()

Method Details

escapeQuotes

public static CharSequence escapeQuotes(CharSequence input)

Escape single and double quotes so that they can be part of e.g. an alert call. Note: JSON values need to escape only the double quote, so this method wont help.

Parameters:

input - the JavaScript which needs to be escaped

Returns:

Escaped version of the input

writeScript

public static void writeScript(Response response,
 AttributeMap attributes)

Write a reference to a javascript file to the response object

Parameters:

response - The HTTP response

attributes - Extra tag attributes

writeInlineScript

public static void writeInlineScript(Response response,
 CharSequence text,
 AttributeMap attributes)

Write the simple text to the response object surrounded by a script tag.

Parameters:

response - The HTTP: response

text - The text to added in between the script tags

attributes - Extra tag attributes

writeJavaScript

public static void writeJavaScript(Response response,
 CharSequence text)

Write the simple text to the response object surrounded by a script tag.

Parameters:

response - The HTTP: response

text - The text to added in between the script tags

writeOpenTag

public static void writeOpenTag(Response response,
 AttributeMap attributes)

Write open script tag for inline script. Content is prefixed with SCRIPT_CONTENT_PREFIX.

Parameters:

response - the response to write to

attributes - Tag attributes map

writeCloseTag

public static void writeCloseTag(Response response)

Write close script tag for inline script. The close tag is prefixed with SCRIPT_CONTENT_SUFFIX

Parameters:

response - the response to write to