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

java.lang.Object
  extended by org.apache.velocity.app.event.implement.EscapeReference
      extended by 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  String escape(Object text)
          Escapes the characters in a String to be suitable for use in JavaScript.
protected  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 String escape(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 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"


Copyright © 2000-2012 The Apache Software Foundation. All Rights Reserved.