org.apache.velocity.app.event.implement
Class EscapeJavaScriptReference

java.lang.Object
  org.apache.velocity.app.event.implement.EscapeReference
      org.apache.velocity.app.event.implement.EscapeJavaScriptReference

All Implemented Interfaces:

EventHandler, ReferenceInsertionEventHandler, RuntimeServicesAware

public class EscapeJavaScriptReference
extends EscapeReference

Escapes the characters in a String to be suitable for use in JavaScript.

Since:

1.5

Author:

wglass

See Also:

StringEscapeUtils

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.velocity.app.event.ReferenceInsertionEventHandler

ReferenceInsertionEventHandler.referenceInsertExecutor

Constructor Summary

EscapeJavaScriptReference()

Method Summary

protected java.lang.String	escape(java.lang.Object text) Escapes the characters in a String to be suitable for use in JavaScript.
protected java.lang.String	getMatchAttribute() Specify the configuration attribute that specifies the regular expression.

Methods inherited from class org.apache.velocity.app.event.implement.EscapeReference

getRuntimeServices, referenceInsert, setRuntimeServices

Methods inherited from class java.lang.Object

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

Constructor Detail

EscapeJavaScriptReference

public EscapeJavaScriptReference()

Method Detail

escape

protected java.lang.String escape(java.lang.Object text)

Escapes the characters in a String to be suitable for use in JavaScript.

Specified by:

escape in class EscapeReference

Parameters:

text -

Returns:

An escaped String.

See Also:

StringEscapeUtils

getMatchAttribute

protected java.lang.String getMatchAttribute()

Description copied from class: EscapeReference

Specify the configuration attribute that specifies the regular expression. Ideally should be in a form

eventhandler.escape.XYZ.match

where XYZ is the type of escaping being done.

Specified by:

getMatchAttribute in class EscapeReference

Returns:

attribute "eventhandler.escape.javascript.match"