org.apache.myfaces.shared.renderkit.html.util
Class HTMLEncoder

java.lang.Object
  extended by org.apache.myfaces.shared.renderkit.html.util.HTMLEncoder

public abstract class HTMLEncoder
extends java.lang.Object

Converts Strings so that they can be used within HTML-Code.


Constructor Summary
HTMLEncoder()
           
 
Method Summary
static void encode(char[] string, int offset, int length, boolean encodeNewline, boolean encodeSubsequentBlanksToNbsp, boolean encodeNonLatin, java.io.Writer writer)
          Encodes the given string, so that it can be used within a html page.
static void encode(char[] string, int offset, int length, boolean encodeNewline, boolean encodeSubsequentBlanksToNbsp, java.io.Writer writer)
          Variant of encode(java.lang.String) where encodeNbsp and encodeNonLatin are true
static void encode(char[] string, int offset, int length, boolean encodeNewline, java.io.Writer writer)
          Variant of encode(java.lang.String) where encodeNbsp is true.
static void encode(char[] string, int offset, int length, java.io.Writer writer)
          Variant of encode(java.lang.String) where encodeNewline is false and encodeNbsp is true.
static java.lang.String encode(java.lang.String string)
          Variant of encode(java.lang.String) where encodeNewline is false and encodeNbsp is true.
static java.lang.String encode(java.lang.String string, boolean encodeNewline)
          Variant of encode(java.lang.String) where encodeNbsp is true.
static java.lang.String encode(java.lang.String string, boolean encodeNewline, boolean encodeSubsequentBlanksToNbsp)
          Variant of encode(java.lang.String) where encodeNbsp and encodeNonLatin are true
static java.lang.String encode(java.lang.String string, boolean encodeNewline, boolean encodeSubsequentBlanksToNbsp, boolean encodeNonLatin)
          Encodes the given string, so that it can be used within a html page.
static java.lang.String encodeURIAtributte(java.lang.String string, java.lang.String characterEncoding)
          Encode an URI, escaping or percent-encoding all required characters and following the rules mentioned on RFC 3986.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HTMLEncoder

public HTMLEncoder()
Method Detail

encode

public static java.lang.String encode(java.lang.String string)
Variant of encode(java.lang.String) where encodeNewline is false and encodeNbsp is true.


encode

public static java.lang.String encode(java.lang.String string,
                                      boolean encodeNewline)
Variant of encode(java.lang.String) where encodeNbsp is true.


encode

public static java.lang.String encode(java.lang.String string,
                                      boolean encodeNewline,
                                      boolean encodeSubsequentBlanksToNbsp)
Variant of encode(java.lang.String) where encodeNbsp and encodeNonLatin are true


encode

public static java.lang.String encode(java.lang.String string,
                                      boolean encodeNewline,
                                      boolean encodeSubsequentBlanksToNbsp,
                                      boolean encodeNonLatin)
Encodes the given string, so that it can be used within a html page.

Parameters:
string - the string to convert
encodeNewline - if true newline characters are converted to <br>'s
encodeSubsequentBlanksToNbsp - if true subsequent blanks are converted to &nbsp;'s
encodeNonLatin - if true encode non-latin characters as numeric character references

encode

public static void encode(char[] string,
                          int offset,
                          int length,
                          java.io.Writer writer)
                   throws java.io.IOException
Variant of encode(java.lang.String) where encodeNewline is false and encodeNbsp is true.

Throws:
java.io.IOException

encode

public static void encode(char[] string,
                          int offset,
                          int length,
                          boolean encodeNewline,
                          java.io.Writer writer)
                   throws java.io.IOException
Variant of encode(java.lang.String) where encodeNbsp is true.

Throws:
java.io.IOException

encode

public static void encode(char[] string,
                          int offset,
                          int length,
                          boolean encodeNewline,
                          boolean encodeSubsequentBlanksToNbsp,
                          java.io.Writer writer)
                   throws java.io.IOException
Variant of encode(java.lang.String) where encodeNbsp and encodeNonLatin are true

Throws:
java.io.IOException

encode

public static void encode(char[] string,
                          int offset,
                          int length,
                          boolean encodeNewline,
                          boolean encodeSubsequentBlanksToNbsp,
                          boolean encodeNonLatin,
                          java.io.Writer writer)
                   throws java.io.IOException
Encodes the given string, so that it can be used within a html page.

Parameters:
string - the string to convert
encodeNewline - if true newline characters are converted to <br>'s
encodeSubsequentBlanksToNbsp - if true subsequent blanks are converted to &nbsp;'s
encodeNonLatin - if true encode non-latin characters as numeric character references
Throws:
java.io.IOException

encodeURIAtributte

public static java.lang.String encodeURIAtributte(java.lang.String string,
                                                  java.lang.String characterEncoding)
                                           throws java.io.IOException
Encode an URI, escaping or percent-encoding all required characters and following the rules mentioned on RFC 3986.

Parameters:
string -
encodeNonLatin -
Returns:
Throws:
java.io.IOException


Copyright © 2010 The Apache Software Foundation. All Rights Reserved.