jangaroo-runtime.2.0.19.source-code.encodeURI.as Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jangaroo-runtime

There is a newer version: 4.1.8

/**
 * API and documentation by Adobe?.
 * Licensed under http://creativecommons.org/licenses/by-nc-sa/3.0/
 */
package {

/**
 * Encodes a string into a valid URI (Uniform Resource Identifier). Converts a complete URI into a string in which all characters are encoded as UTF-8 escape sequences unless a character belongs to a small group of basic characters.
 * The following table shows the entire set of basic characters that are not converted to UTF-8 escape sequences by the encodeURI function.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Characters not encoded
0 1 2 3 4 5 6 7 8 9
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
; / ? : @ & = + $ , #
- _ . ! ~ * ' ( )
 * @param uri A string representing a complete URI.
 * 
 * @return A string with certain characters encoded as UTF-8 escape sequences.
 *
 * @see #decodeURI()
 * @see #decodeURIComponent()
 * @see #encodeURIComponent()
 *
 * @example
 *  * package {
 *     import flash.display.Sprite;
 *
 *     public class EncodeURIExample extends Sprite {
 *         public function EncodeURIExample() {
 *             var uri:String = "http://www.example.com/application.jsp?user=";
 *             var encoded:String = encodeURI(uri);
 *             var decoded:String = decodeURI(encoded);
 *             trace(uri);        // http://www.example.com/application.jsp?user=
 *             trace(encoded);    // http://www.example.com/application.jsp?user=%3Cuser%20name='some%20user'%3E%3C/user%3E
 *             trace(decoded);    // http://www.example.com/application.jsp?user=
 *         }
 *     }
 * }
 * 
 */
[Native]
public native function encodeURI(uri : String) : String;

}