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 and Description
static String	SCRIPT_CLOSE_TAG Script close tag including content suffix
static String	SCRIPT_CONTENT_PREFIX Prefix for JavaScript CDATA content.
static String	SCRIPT_CONTENT_SUFFIX Suffix for JavaScript CDATA content.
static String	SCRIPT_OPEN_TAG Script open tag including content prefix

Constructor Summary

Constructors

Constructor and Description
JavaScriptUtils(Response response) Constructor without id for backward compatibility
JavaScriptUtils(Response response, String id) Construct.

Method Summary

Modifier and Type	Method and Description
void	close() Write the script close tag to the response.
static CharSequence	escapeQuotes(CharSequence input) Escape single and double quotes so that they can be part of e.g.
void	println(CharSequence script)
void	write(CharSequence script)
static void	writeCloseTag(Response response)
static void	writeJavaScript(Response response, CharSequence text) Write the simple text to the response object surrounded by a script tag.
static void	writeJavaScript(Response response, CharSequence text, String id) Write the simple text to the response object surrounded by a script tag.
static void	writeJavaScriptUrl(Response response, CharSequence url) Write a reference to a javascript file to the response object
static void	writeJavaScriptUrl(Response response, CharSequence url, String id) Write a reference to a javascript file to the response object
static void	writeJavaScriptUrl(Response response, CharSequence url, String id, boolean defer, String charset) Write a reference to a javascript file to the response object
static void	writeJavaScriptUrl(Response response, CharSequence url, String id, boolean defer, String charset, boolean async) Write a reference to a javascript file to the response object
static void	writeOpenTag(Response response)
static void	writeOpenTag(Response response, String id)

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

JavaScriptUtils

public JavaScriptUtils(Response response,
                       String id)

Construct.

Parameters:

response - The response object

id -

JavaScriptUtils

public JavaScriptUtils(Response response)

Constructor without id for backward compatibility

Parameters:

response - The response object

Method Detail

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

writeJavaScriptUrl

public static void writeJavaScriptUrl(Response response,
                                      CharSequence url,
                                      String id)

Write a reference to a javascript file to the response object

Parameters:

response - The HTTP response

url - The javascript file URL

id - Unique identifier of element

writeJavaScriptUrl

public static void writeJavaScriptUrl(Response response,
                                      CharSequence url,
                                      String id,
                                      boolean defer,
                                      String charset)

Write a reference to a javascript file to the response object

Parameters:

response - The HTTP response

url - The javascript file URL

id - Unique identifier of element

defer - specifies that the execution of a script should be deferred (delayed) until after the page has been loaded.

charset - a non null value specifies the charset attribute of the script tag

writeJavaScriptUrl

public static void writeJavaScriptUrl(Response response,
                                      CharSequence url,
                                      String id,
                                      boolean defer,
                                      String charset,
                                      boolean async)

Write a reference to a javascript file to the response object

Parameters:

response - The HTTP response

url - The javascript file URL

id - Unique identifier of element

defer - specifies that the execution of a script should be deferred (delayed) until after the page has been loaded.

charset - a non null value specifies the charset attribute of the script tag

async - specifies that the script can be loaded asynchronously by the browser

writeJavaScriptUrl

public static void writeJavaScriptUrl(Response response,
                                      CharSequence url)

Write a reference to a javascript file to the response object

Parameters:

response - The HTTP response

url - The javascript file URL

writeJavaScript

public static void writeJavaScript(Response response,
                                   CharSequence text,
                                   String id)

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

id - Unique identifier of element

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,
                                String id)

Parameters:

response -

id -

writeOpenTag

public static void writeOpenTag(Response response)

Parameters:

response -

writeCloseTag

public static void writeCloseTag(Response response)

Parameters:

response -

write

public void write(CharSequence script)

Parameters:

script -

See Also:

Response.write(java.lang.CharSequence)

println

public void println(CharSequence script)

Parameters:

script -

See Also:

Response.write(CharSequence)

close

public void close()

Write the script close tag to the response. The response output stream remains open.